Stack Overflow
Stack Overflow

Questions tagged [apiary]

Next generation platform for building and using REST APIs.

136 questions
2
votes
1 answer

api blueprint mson object with different values

I have a collection response which gives back an array of user objects and want to have different values for the user attributes without to create multiple user objects. Is there a way to do this? # Group Users ## Users Collection…
SteveObrian
  • 41
  • 4
2
votes
2 answers

Dredd / apiary / MSON array of any size

we're struggling describing an array of any size in our API. Using API Blueprint and MSON format for Dredd testing. Endpoint /spots should return an array of "Spots" (those are objects). We don't know how many though. Currently we have only been…
vicdup
  • 149
  • 4
2
votes
1 answer

How can I specify a shared Headers section across all Apiary/Blueprint API requests?

I have a large API document and each request has the same request headers like Accept: application/json and Cookies: SessionID. Is there a way I can declare these globally to avoid the duplication?
Art
  • 5,704
  • 3
  • 28
  • 32
2
votes
1 answer

Choose a tools to documents REST API

I actually use Doxygen to document my php REST application and I just discover Apiary & Swagger witch seem to be good tools to document API...I want to know if there is a way to generate documentation automatically using one of this tools (apiary or…
Betty
  • 47
  • 8
2
votes
1 answer

More [GET] request-response examples with different URI parameters

I have an URI: /lessons/{language}/{type} I would like to have more mock requests-responses with different parameters {language} and {type} in my blueprint. It seems to me that this is not possible for GET method. My idea is that: GET…
Jirik
  • 1,049
  • 8
  • 16
2
votes
2 answers

Nested array with object in MSON is empty in Apiary.io documentation

I would like to create a nested array with objects in MSON format to use with API Blueprint and Apiary. I code looks correct but when I render it in Apiary I don't get the expected JSON. Example I want to create: A navigation has multiple…
JeroenVdb
  • 788
  • 1
  • 12
  • 21
2
votes
1 answer

Apiary Proxy Request Timed Out

I'm trying to use Apiary to document my API and test requests but I keep getting a response 504 Proxy Request Timed Out. My API is running on my machine under http://localhost:3000/ and I specified that under the HOST metadata. When I click…
WorkForPizza
  • 75
  • 6
2
votes
1 answer

How to add API version to Apiary Mock Server

Is there any way to add API version to Apiary Mock Server? Ex.: http://private-XXXXX-apiname.apiary-mock.com/v1/mocks/1?school_id=1
joaofraga
  • 580
  • 6
  • 17
2
votes
2 answers

How to model different requests to same resource in api-blueprint/apiary

I'm writing some API definitions with apiary/api blueprint. Is there a way that, for the same resource, I can use the mock endpoint to behave differently depending on input (or failing that, some kind of work around)? For example, say I have an…
user384842
  • 1,896
  • 2
  • 15
  • 22
2
votes
1 answer

Create Mock Service API using Apiary

I'm attempting to create mock api services for testing purposes. We are already using Apiary on another team so I'm starting there. So far, I've noticed that if I want to have two separate calls requires mocking out of both requests. For example to…
user919388347489103
  • 21
  • 3
2
votes
1 answer

API Blueprint - How to perform a simple UPDATE

I have went through the documentation of Apiary but did not find out how to create a blue print to update a resource. What I am trying to achieve here is a simple scenario such as having a list of users, being able to list them, retrieve a single…
dukable
  • 3,708
  • 11
  • 29
  • 41
2
votes
1 answer

Is it possible to specify parameters which go into the post body with blueprint?

I'd like to be able to document the parameters as if they were URL parameters, since I like how that bit of documentation renders a handy table. However, in my API, I would like those paremeters to plug into the JSON body rather than the URL. Is…
Eugene
  • 2,749
  • 2
  • 22
  • 30
2
votes
2 answers

Does Apiary.io throttle responses?

I have an angularjs app that calls a RESTful service at apiary.io Does apiary.io throttle responses and delay responses after a certain number have been received? If so what are the parameters?
Greg Pagendam-Turner
  • 1,826
  • 3
  • 24
  • 43
2
votes
1 answer

Apiary: Refer to multiple models in a body

It seems you can only refer to the model itself in an unmodified form from a payload/body section: # Item [/] + Model { "name" : "an item" } ## GET + Response 200 [Item][] Is there any way to return an array of the model or use the…
billc.cn
  • 6,543
  • 2
  • 33
  • 69
1
vote
0 answers

MSON data structures from external file

I want to use the MSON data structure defined in an external file and refer to it in my API blueprint file. Is it possible? As of now I define both in the same file. FORMAT: 1A HOST: https://polls.apiblueprint.org/ # Suppliers CRUD API to…
anil
  • 109
  • 1
  • 6
1 2
3
…
9 10