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
4
votes
1 answer

API Blueprint schema usage

We want to use API blueprint together with a schema. Let's say, we want to specify that PUT to a resource accepts an Account in the payload and GET on the same resource returns an Account payload. So I need to specify that Account is used in GET and…
user2790329
  • 41
  • 2
3
votes
1 answer

Rendering attributes on aglio?

I'm new to aglio I was trying to render attributes for my documentation, but it does not work. ## Modify User [/users/{id}.json?{token}=API_TOKEN] Modify any accessible fields if authorized ### Modify User [PUT] + Parameters + id: 1 (required,…
Jonathan Bouchard
  • 423
  • 1
  • 4
  • 15
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
0 answers

API Blueprint: Best way to denote file upload?

How would I denote a REST API using API Blueprint that is similar to the Google Drive API I'm expecting uploads of all different kinds of files so I see drive handles "multipart" uploads. I'd likely need to do something similar to that too. How…
Tyler James Leonhardt
  • 804
  • 1
  • 9
  • 24
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
1 answer

JSON to blueprint/MSON

I havent been able to find any tools for this conversion, does anyone know of any that exist. Currently, I have JSON data from Swagger that I would like to convert to Blueprint/MSON to use with Apiary, but I am not sure if this is possible. Any…
hmucity
  • 31
  • 5
3
votes
1 answer

How do you specify request body attributes in Apiary.io / API Blueprint?

I'm trying to figure out how to describe/define the request body attributes/parameters for POST/PUT. Here is an example of what I'm trying to do, but I can't find it anywhere in the documentation (I wish there was a way to view the markdown of any…
booshong
  • 782
  • 6
  • 21
3
votes
1 answer

Generating API documentation from Java Cloud Endpoint

I'm looking for an efficient way to generate API documentation in a readable format, from the generated files from Cloud Endpoint (Java). The generated files are either: - my_api.api - my_api*.discovery Something that looks like this: -…
mabruneau
  • 53
  • 6
3
votes
1 answer

Blueprint API show all possible values for Enum in Response Body

When writing an API-Deocumentation for an rest-service I came across an problem where I wanted to list all the possible Values which could be returned as a response. In the case below it would be the "state" field which could contain any possible…
Edub
  • 508
  • 7
  • 24
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
3
votes
1 answer

How can I specify multiple request types per endpoint in API Blueprint?

Is it possible to define what happens when PUT to /asdf with an empty request body happens vs PUT to /asdf with this request body with { "value": "somthing" }.
Jinyoung Kim
  • 2,171
  • 20
  • 32
3
votes
1 answer

When drafting an API Blueprint document, how can I annotate a response?

I’d like to annotate some error responses, like so: * Response 412 If the Etag supplied in `If-Match` didn’t match. * Response 428 If the request didn’t include the header `If-Match`. but the parser (snowcrash) seems to be interpreting the…
Avi Flax
  • 50,872
  • 9
  • 47
  • 64
3
votes
1 answer

Encoded request bodies in Blueprint at apiary.io

We have one existing API, which we're trying to build a Blueprint for, that requires certain request bodies to be URI-encoded JSON. Is there some way to specify a body as "like this, but encoded"? Existing (mere text) documentation just shows the…
jackr
  • 1,407
  • 1
  • 14
  • 29
1 2 3
…
16 17