Next generation platform for building and using REST APIs.
Questions tagged [apiary]
138 questions
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
- 14,154
- 15
- 58
- 97
5
votes
1 answer
How to document POST parameters with Apiary?
I've written a small web service that was designed to be "curl-able", so it relies on application/x-www-form-urlencoded parameters in POST requests, e.g.:
curl http://api.example.com/ -d param1=foo -d param2=bar
I would like to document this…
larsks
- 277,717
- 41
- 399
- 399
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
- 3,743
- 1
- 21
- 18
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/
Behrang
- 46,888
- 25
- 118
- 160
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,339
- 1
- 16
- 20
3
votes
1 answer
Apiary API endpoint returning null data when called from web
I have a mock API in Apiary where if I hit my endpoint with cURL or just in the browser, it returns:
[
{
"id": 1,
"user_id": 1,
"status": "Review"
"name": "New York Songwriter",
"negotiable": true,
"description": "",
"created_at":…
Cassidy
- 3,328
- 5
- 39
- 76
3
votes
1 answer
How to document Webhooks in Apiary/API Blueprint
I'm just starting with api blueprint, using apiary to generate the docs for our api. We have both a REST api and a number of webhooks. The REST api is easy enough to create, but I can't figure out how best to generate the documentation for the…
CTC
- 451
- 1
- 8
- 20
3
votes
1 answer
Blueprint array of objects (apiary)
I'm trying to describe array of objects with syntax based on this answer
+ Response 200 (application/json)
+ Attributes
+ time (object, required)
+ default (string, required) - `HH:MM` default time
+ times (array,…
Aleš Oskar Kocur
- 1,381
- 1
- 13
- 29
3
votes
1 answer
MSON specifying a date-time
How can the following MSON output a schema with "format":"date-time", similar to the stated below?
Mson:
FORMAT: 1A
# Some API
## series [/api/v1/series]
Returns a list of series.
### View all series [GET]
+ Response 200 (application/json;…
user1990009
- 855
- 1
- 7
- 16
3
votes
2 answers
Dredd testing of APIary calls returning an image / PNG
Dredd tests of APIary calls returning an image / PNG fail. Is it possible to check not the content of the returned image but just that there is an image not null as response?
Here is the output of my test:
[31mfail [39m: GET…
user3328145
- 51
- 5
3
votes
1 answer
Can't build an F# project using the ApiaryTypeProvider. FSharp.Data.DesignTime can not be found
I have an F# Library Project ( Not Portable Library ) with the following code:
let db = new ApiaryProvider<"themoviedb">("http://api.themoviedb.org")
db.AddQueryParam("api_key", TmdbApiKey)
let test =
let movie =…
Andy B
- 541
- 2
- 13
3
votes
2 answers
API Bluprint documentation of query string parameters with Rails' array notation
I'm not having much luck trying to use resourceful documentation for an API URI which uses Rails' array parameter notation
For example (the unencoded URL for clarity):
/api/v2/profiles?ids[]=35&ids[]=47&ids[]=12&ids[]=132
and the actual encoded…
James H
- 1,824
- 22
- 23
3
votes
1 answer
Reuse a resource model as an array
I'm documenting an API and I have 2 responses very similar.
One of them is the call /resource/{id}.
This response returns a resource model.
The other call is /resource/search{?name,category} which returns a list of resources so I need to return an…
Germán Lena
- 867
- 1
- 6
- 15
3
votes
1 answer
What is the convention to specify data types of attributes in apiary.io markdown?
The apiary.io list resource attributes in point form. Is there a specific convention to show what data type these attributes are, or met data specifying formats?
Jev Björsell
- 891
- 1
- 9
- 25
2
votes
0 answers
Document POST request with API blueprint and Apiary
I am documenting a service with API endpoints which need to be accessed with a POST request in application/x-form-urlencoded format with Apiary. The issue is, no matter how much I looked, I could not find any mention of that, or any sort of…
frogstair
- 444
- 5
- 20