Next generation platform for building and using REST APIs.
Questions tagged [apiary.io]
162 questions
1
vote
1 answer
If I specify API version in the URL, should I offer an option to have it in the header as well?
I'm designing my API, and I specify an optional API version in the URL
GET /Issuer/{certificate-name}/versions?api-version=2016-10-01[&maxresults]
Should I also have one specified in the HTTP Header (for flexibility)?
What should I do if there is a…

makerofthings7
- 60,103
- 53
- 215
- 448
1
vote
1 answer
How to provide mock data for Apiary Mock Server?
apiary service provides Mock Server, that is generated based on API description written either in API Blueprint or Swagger syntax.
In my API description I have an action returning collection of data. This collection is large, so there is filtering…

EvAlex
- 2,888
- 1
- 20
- 24
1
vote
1 answer
Unable to fetch apiary.apib using the apiary CLI fetch command (even though i am using my apiary access token)
I am trying to fetch my apiary documentation (on the apiary server) to my local drive. I am the owner of the API and have access to the Settings button (I thought maybe this is important since i get a 403 forbidden response in the end, see below).…

Shachar R
- 311
- 1
- 2
- 8
1
vote
1 answer
How to write code snippet in apiary.io?
I am using apiary.io and added all restful endpoints. It looks great, there are code snippets in many languages how to make GET request and get the results.
Now, I want to add a code snippet to the documentation, which is not related to any…

giliev
- 2,938
- 4
- 27
- 47
1
vote
1 answer
Apiary Error when invoking API
I get the following error on ApiaryWe are sorry, but the API call failed.
My host is defined as
FORMAT: 1A
HOST: https://test.mynetwork.com/
GET CALL IS DEFINED AS
data urn [models/v2/files/{urn}/data{?guid}]
GET [GET]
Parameters
urn (required,…

beginlearning
- 13
- 3
1
vote
0 answers
ERROR : java.lang.NoClassDefFoundError: Failed resolution of: Ljavax/xml/stream/XMLInputFactory;
I am trying to build an app using a REST api (Apiary) with Android Studio but I am not sure to do it well.
Here is my build.gradle file :
apply plugin: 'com.android.application'
android {
compileSdkVersion 23
buildToolsVersion…

LeaPwr
- 21
- 1
- 4
1
vote
1 answer
Is there any way to send empty optional query parameters?
I'm writing documentation for API, and got problem.
Here is link definition:
### Get hotels availability [GET /agent/v1/hotel/availability{?regions,hotels,from,to,limit,offset}]
Parameters:
+ Parameters
+ regions (required,string,`399,189`)
…

ineersa
- 3,445
- 30
- 40
1
vote
1 answer
MSON to describe object attributes in blueprint
I have an issue similar to what is described here.
I have a JSON that looks like this:
{
"photos": [
{
"key": "y37dmj10jkwof/moOIUB8912JKVgh",
"caption": "A world of gamers.",
"tags": [
"game",
"japan"
…

Stefan
- 1,214
- 1
- 9
- 17
1
vote
1 answer
defining json post parameters in apiary
I'm trying to create documentation for a project using json post requests.
Now for get requests I can easily define uri parameters.
However I want to do the same for json and other post requests.
I tried and wished it would work something like…

HTDutchy
- 1,090
- 2
- 13
- 25
1
vote
2 answers
APIARY Mock JSON Data for multiple Single Object
In my apiary, I have defined the following to retrieve one id when id is passed to
A single Note object with all its details
{ "id": 2, "title": "Pick-up posters from post-office" }
http://private-22c1f-polpan.apiary-mock.com/notes/2
If I would…

Jacob
- 14,463
- 65
- 207
- 320
1
vote
2 answers
Using Dancer2::Plugin::DBIC to pull values from database
I have a webapp where a user can log in and see a dashboard with some data. I'm using APIary for mock data and in my Postgres Database each of my users have an ID. These ID's are also used in the APIary JSON file with relevant information.
I'm…

vanilla_splsh
- 153
- 1
- 12
1
vote
2 answers
How to install Apiaryio Drafter on Windows 8?
I wanted to install apiaryio/drafter on windows.
I installed python 2.7 and visuall studio 12 "Full version". It needed to add some folders to system path because of not finding some files like "mspdb110.dll". But the latest problem related to…

MJBZA
- 4,796
- 8
- 48
- 97
1
vote
1 answer
How to verify POST documentation in Apiary
I've created a couple of C# unit tests that perform GETs on the Apiary mock server and check that the JSON returned (i.e. the documentation) matches the statically-typed object I expect to be returned (hence checking that the documentation matches…

Dan Fox
- 143
- 8
1
vote
1 answer
API Blueprint resource definition not working correctly
This blueprint resource is giving me problems.
#Group Data Ingress
## Inbound SMS [/api/v1/inboundSMS{?number,message,key}]
### Receive [GET]
+ Request
+ Parameters
+ number (int) ... The number the sms originated from
+…

Sam
- 5,416
- 7
- 47
- 49
1
vote
1 answer
customize the apiary console drop-down menu
I want to customize the apiary console's drop-down menu. Here is my use-acases
I have added the HOST field in apiary blueprint which is a url of a staging server. In console, by default, the drop-down menu shows production name for this url.
1). Is…

navyad
- 3,752
- 7
- 47
- 88