Stack Overflow
Stack Overflow

Questions tagged [apiblueprint]

API Blueprint is a Markdown-based DSL for describing HTTP APIs.

API Blueprint is a Markdown-based DSL for describing HTTP APIs.

Documentation, opensourced parser and other utilities available at http://apiblueprint.org/

250 questions
5
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
  • 1,040
  • 2
  • 13
  • 26
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

Facebook API in machine readable format

Where I can find the Facebook API in a format like http://swagger.io, https://apiblueprint.org or http://raml.org? I want to read and request the facebook server (api) "half-atomatic". My script knowns how to interact with the facebook server. And…
Tobias Oberrauch
  • 217
  • 6
  • 15
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
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,978
  • 5
  • 26
  • 47
4
votes
1 answer

How to specify multiple possible types (type union) for array in MSON?

I'm struggling a bit to describe what I need exactly but I spent some time browsing the MSON spec and didn't find anything. This example is a bit contrived but hopefully the intention is clear. # Animal (object) This is a base class for all…
user1915201
  • 103
  • 1
  • 9
4
votes
2 answers

How can I set environment variables for dredd testing in a dredd.yml file?

I'm trying to run a number of api calls using dredd and api blueprint to test a site. I would like to run the tests on circleCI, as there are Selenium tests running in the same place. Each transaction needs to be accompanied by two tokens, which are…
Brydenr
  • 798
  • 1
  • 19
  • 30
4
votes
1 answer

Api Blueprint and long running jobs

I would like to properly design my json API with long running jobs with Blueprint. I need to process files, return a 202 Accepted with a location header and then design the temporary location who will receive 303 See Other and then the final object…
Mio
  • 1,412
  • 2
  • 19
  • 41
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
1 answer

Is it possible to import and/or export API Blueprint to/from Swagger and/or RAML?

Is it possible to bridge between any of the formats? Thank you.
jim
  • 41
  • 2
4
votes
2 answers

what is swagger exactly ? And why doesn't the online editor run requests?

I've spent the last few days trying to understand if I should use api blueprint, RAML or swagger. It looks like swagger has the biggest community but the closer I look the more I feel that it greatly lacks in documentation (I was forced to look at…
coiso
  • 7,151
  • 12
  • 44
  • 63
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
4
votes
2 answers

Generate API docs via code comments

I'm using aglio to generate my API documentation. I'm currently writing the raw markdown for this based on the API Blueprint spec. I'm wondering if there's a way to generate the markdown via comments directly in the code. Is anyone aware of a way…
hellopat
  • 1,799
  • 2
  • 14
  • 14
4
votes
1 answer

In an API Blueprint document, can I combine a model with headers?

The “model” facility seems intended to reduce duplication — when specifying the requests and responses to various methods on a resource, the same body will frequently be specified multiple times. So one can define a “model” and then “refer” to it…
Avi Flax
  • 50,872
  • 9
  • 47
  • 64
1 2
3
…
16 17