July 2017
Beginner to intermediate
358 pages
10h 54m
English
API Blueprint is an open standard designed by Apiary and released under the MIT license. It ties closely into Apiary's products. However, it can be used on its own, and there are a variety of open source tools that read and write the format.
Documentation is written in Markdown, which can make authoring the documentation feel a little more natural rather than dealing with nested layers of objects.
The code example for API Blueprint is shown as follows:
FORMAT: 1A # Data Structures ## Pet (object) + name: Jason (string) - Name of the pet. # Pets [/pets] Returns all pets from the system that the user has access to'to' ## Retrieve all pets [GET] + Response 200 (application/json) + Attributes (array[Pet])
Find more information ...
Read now
Unlock full access