apiblueprint

Does api blueprint or Apiary.io support the notion of versioning your API? In particular, I'm versioning my API via the URI like this: GET /api/v2/SomeResource/ In the example above, this means I'm calling version 2 ("v2") of the API. Does api blueprint support this? How can I document multiple versions of a given action or the entire API? You can use HOST header to signify that: HOST: http://example.com/api/v2 is going to prefix all resources with /api/v2 . In the API Blueprint, if you use URL prefixing, the APIs are considered different and therefore you should use different blueprints for

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 get the notes with ids 1 and 2 requires explicitly writing out responses like: /notes/1 /notes/2 Is there a way to avoid this? Admittedly I'm still ramping up on creating blueprints. Have a look at private-e9e59-pingdomcheck.apiary-mock.com/v1/gists/1 . The number 1 is {id} here. You of course get only the general defined response (like if I used id

In API blueprint I am looking to specify an optional json element for a POST message. Example for; ### Add a new User [POST] To add a User send a JSON ..... + Request (application/json) { "name": "A name", "age": 30 } How do I indicate to reader of API that age is optional in API call but still show that it's an integer? ~Colin Currently there is no dedicated support for doing this. However there are few ways how to achieve this. My preferable is to discuss it in the request description using a markdown formatting of your liking e.g: ### Add a new User [POST] To add a User send a JSON ..... +

I'm trying to document a query parameter in API Blueprint, but I'm not entirely sure if I have done it correctly. The resource looks like this: DELETE http://baasar.apiary-mock.com/user/{appId}/{userId} That request would deactivate the user while the following would delete the user object: DELETE http://baasar.apiary-mock.com/user/{appId}/{userId}?force=true This is the Blueprint markdown I have for this: ## User [/user/{appId}/{userId}] Handle user objects + Parameters + appId (required, number, `1`) ... Application ID (`appId`) + userId (required, number, `1`) ... Numeric `userId` of the

I am trying to get different responses passing different parameters but something is not working. This is my API: ## Question [/questions/{question_id}] A Question object has the following attributes: + Parameters + question_id: `1` (number, required) - ID of the Question in form of an integer ### View a Questions Detail [GET] + Request + Header X-Custom-Header : 1 + Response 200 (application/json) { "id": "1", "name": "Marco" } + Request + Header X-Custom-Header : 2 + Response 200 (application/json) { "id: "2", "name": "Lucas" } But when calling /questions/1 or /questions/2 the response is