Next generation platform for building and using REST APIs.
Questions tagged [apiary.io]
158 questions
7
votes
2 answers
How to export Apiary Blueprint as PDF, stand-alone HTML or similar "deliverable"?
We need to export our Apiary Blueprint for task assignment purposes as a self containing "deliverable" like PDF or ZIP or similar. I'm aware of the feature request and the discussion below. Is it possible to "hack" something better than the poor…
Rodja
- 7,656
- 8
- 43
- 53
7
votes
1 answer
Specify description for every response we have in Apiary.io
Is it possible to specify description for every response to some request? Suppose, we have a request
### Retrieve resource [GET]
+ Headers
If-None-Match: "Version1"
And 2 responses
+ Response 200 (application/xml)
+ Headers
…
Dmitrii Lobanov
- 4,697
- 1
- 31
- 47
6
votes
1 answer
Using generic named type in API Blueprint on Apiary.io
How can I use generic named type in my API Blueprint definition?
I try like this:
FORMAT: 1A HOST: http://test.com/
# API Blueprint testing.
## Resource [/resources]
### Action [GET]
+ Response 200 (application/json)
+ Attributes
+…
bovin.a
- 123
- 6
6
votes
2 answers
How can I add images/diagrams to API Blueprint?
We would like to integrate images into our API documentation on Apiary, as a way of documenting the underlying application architecture or to illustrate sample workflows/sequence diagrams. However, a search through Apiary documentation and the API…
David
- 1,959
- 20
- 22
6
votes
1 answer
Use pattern in API Blueprint / MSON
I'm investigating the possibilities of the new Data Structures syntax in API Blueprint, especially MSON. Is it possible to attach or rather specify something like a pattern (regex)? Don't found anything on this topic.
loxy
- 283
- 2
- 9
6
votes
3 answers
How to reuse objects in schema of API BluePrint?
I have created an API that delivers a resource named "Thumbnail" (/thumbnails)
{
"name": "toto",
"uri": "http://xxx"
}
In other hand I have multiple resources that includes that Thumbnail resource in them (like /articles, /videos ...):
{
…
Stéphane Pessin
- 79
- 3
6
votes
2 answers
How to depict sessions in api blueprint format?
I am currently trying to depict a existing API with apiary.io. The system implements authentication via a login request that returns a http-cookie containing a session-id.
As far as I know it is standard that a browser sends all http-cookies he…
Florian Loch
- 789
- 5
- 12
5
votes
2 answers
API Blueprint - Avoid repeating authorization blocks
In API Blueprint, how do I avoid using the same request Authorization header block over and over for every endpoint?
+ Request (application/json)
+ Headers
Authorization: Bearer jsonWebToken
Is there a way to template this in a…
Drew Baker
- 13,308
- 12
- 50
- 90
5
votes
1 answer
How to access raw apiblueprint markdown?
Given some API documentation docs.someurl.apiary.io (like http://docs.themoviedb.apiary.io), is there some way to see the non formated source api blueprint markdown with something like source.themoviedb.apiary.io ?
I think it could be useful for…
Kpym
- 2,936
- 1
- 17
- 15
4
votes
0 answers
Represent File Uploads in API Blueprints
We have an API end point where an image file can be uploaded along with the name of the file (a string) as well as a description (string).
Apiary / API Blueprints won't allow me to have something like:
+ Request (multipart/form-data)
+ Headers
…
CDub
- 12,780
- 4
- 47
- 65
4
votes
1 answer
What is the purpose of the Host: parameter in Apiary?
What is the purpose of the Host: parameter in Apiary. For example:
FORMAT: 1A
HOST: http://polls.apiblueprint.org/
βξhrαng
- 41,698
- 21
- 103
- 145
4
votes
2 answers
Apiary: Is there a way to define options for parameters?
I would like to define options for Apiary parameters, I'm currently listing them in the description:
measurement = m (optional, string, m) ... measurement e.g. m = meters, km = kilometers, yd = yards, mi = miles
AEQ
- 1,199
- 1
- 15
- 18
4
votes
1 answer
AngularJS and Apiary.IO - can't read any response headers?
I mocking my API using Apiary.io. But somehow I cannot read any headers from response object using angularJS. And I am sure i have at least Content-Type: application/json correctly set-up by checking in firebug. Code in Angular should read headers…
Jakub Kuchar
- 1,616
- 2
- 22
- 38
3
votes
1 answer
How to reference enum value in API Blueprint(MSON)
I'm using API Blueprint and Agilo to render my API documentation. When using enum type, I'm observing a weird behavior. The response is not shown with the defined enum value whereas the schema is showing all the enum values (which is expected) along…
Haran
- 730
- 1
- 8
- 20
3
votes
3 answers
Generating an API blueprint documentation from Django/DRF code
Is there any lib/parser which can generate API blueprint documentation (apiary) from Django + Django Rest Framework code? Eg:
class UserView(...):
"""
## Users list [GET /users]
+ Request (application/json)
...
+ Response…
User
- 1,529
- 4
- 20
- 40