Stack Overflow
Stack Overflow

Questions tagged [apiary.io]

Next generation platform for building and using REST APIs.

162 questions
1
vote
3 answers

multiple responses for a given endpoint in api blueprint

Is it possible in the API Blueprint to define a set of possible responses for a given endpoint? For example if I have a endpoint such as /movie/{id} I'd like to be able to define a set of movie records so that in the mock server I could GET /movie/1…
Charlie
  • 193
  • 1
  • 2
  • 9
1
vote
1 answer

Apiary.io API Blueprint: Action Parameter enforcement for mock service

In my blueprint, I have an action parameter for the GET action that is defined as a required parameter. However when I invoke the mock service endpoint without the parameter I get a legal response. Is there any runtime enforcement corresponding to…
jpk
  • 11
  • 1
1
vote
1 answer

Specify query parameter for a single HTTP method

To illustrate my problem, I made a condensed example from the Apiary.io blueprint tutorial. FORMAT: 1A # Gist Fox API # Group Gist Gist-related resources of *Gist Fox API*. ## Gists Collection [/gists{?since}] ### List All Gists [GET] +…
Leward
  • 125
  • 5
1
vote
1 answer

How to put resource creation and other methods in the same group?

Suppose I create a resource with POST /resource and that yields an id on the response body, and then I use that id to retrieve my resource with GET /resource/{id}. How do I put these two requests in the same API Blueprint group ? Apparently a group…
João Pinto Jerónimo
  • 9,586
  • 15
  • 62
  • 86
1
vote
1 answer

How to add description to the "value" of the query attribute

apiary shows me how to add descriptions to the parameter. However, what I need is having descriptions on the value. For example /users{?skills}. I have my own skill codes for this parameter '1' means can speak English '2' means can swim '3' means…
ATNASGDWNGTH
  • 876
  • 11
  • 26
1
vote
1 answer

Document alternative request bodies

The API we are building allows the user to provide different request bodies. From what I have seen / found so far, it is only possible to provide a single request per action/resource. Is it somehow possible to specify different request bodies? I…
namxam
  • 96
  • 5
1
vote
1 answer

Apiary: Full URL on responses

My API return the full host URL, and in Apiary every user has it's own private URL for the mock server. There's a way to use this URL in the response body? For now I'm using my own URL in the response body.
azee
  • 11
  • 1
  • 3
1
vote
2 answers

How do I get Apiary model details from the rendered documentation?

I have an API contract defined in Apiary and I'm using the Resource model syntax to enable reuse of payloads. The documentation rendered by Apiary only shows the model name though (eg Response 200 returns a [Foo][]) - without any further details on…
Justin
  • 227
  • 2
  • 8
1
vote
1 answer

Apiary JSONP response

Is there some way to use Apiary to respond appropriately to JSONP requests? request looks like: http://myserver.apiary-mock.com/api/v1/startup/dashboard?callback=jQuery20008137053514365107_1400036479208&user_id=1&_=1400036479210 and I need the…
cmcculloh
  • 47,596
  • 40
  • 105
  • 130
1
vote
2 answers

Are there any Apiary.io documentation sources available

I use Apiary.io Blueprint Editor to create awesome documentation for server API. Now, I am still new at this, and I am trying to find out what are the capabilities of this tool. I have seen examples like: http://docs.gooddata.apiary.io/ And I see…
AndroC
  • 4,758
  • 2
  • 46
  • 69
1
vote
2 answers

How can I use apiary with JSON-RPC

I am trying to use apiary.io to document a JSON-RPC based API. I can get the pages formatted, but console simply does not work. With JSON-RPC you typically only have 1 URI, such is the case with our API. Because of this, when attempting to define…
Rob Rodriguez
  • 403
  • 4
  • 9
1
vote
1 answer

How test show/index request with dredd + rails?

I wonder how should I test rails api with dredd, specially the show and index actions(/post{id} and /post) Should I fill my database with records before running dredd, I mean creating record post with id: 1 and so on? Does dredd always trying to…
piotrze
  • 479
  • 5
  • 14
1
vote
1 answer

Dredd - API Blueprint Testing Tool. "Undefined" issue

I installed dredd - API Blueprint Testing Tool and trying to test our APIary API against the implementation. In the blueprint I have just one resource which is correctly implemented on somehost... but test fails :( test command: dredd…
user3328145
  • 51
  • 5
1
vote
1 answer

Square brackets in parameter name

I was wondering if it's possible to include square brackets in the parameter name, which is how Rails groups parameters. For example: + Parameters + person[age] (string) ... Person's age Right now if I include the square bracket, the…
user1202359
  • 45
  • 5
0
votes
0 answers

See who changed the apiary file

We have a role that can edit the file in apiary.io How can I see who changed the file recently? I am not sure if apiary.io saves the details regarding who changed the file.
firstpostcommenter
  • 2,328
  • 4
  • 30
  • 59
1 2 3
…
10 11