A powerful high-level API design language for web APIs.
API Blueprint is simple and accessible to everybody involved in the API design
lifecycle.
Its syntax is concise yet expressive.
API Blueprint language is recognized by GitHub. You can
search for API Blueprint or use the apib language identifier for
syntax highlighting.
All it takes to describe an endpoint of your API is to write:
# GET /message
+ Response 200 (text/plain)
Hello World!in your favorite plain text editor.
To learn more about the API Blueprint syntax jump directly to the API Blueprint Tutorial or take a look at some examples.
The media type for API Blueprint is text/vnd.apiblueprint.
This repository is a fork of the API Blueprint specification by Apiary. It includes some changes compared to the original specification, adds new sections, and drops unused ones.
In FunBox, we created our tools to work with API documentation. You can look at the @funboxteam/crafter and @funboxteam/blueprinter-frontend repositories to get a better understanding of what they are.
These tools are mostly based on the original specification, but some newly implemented features also require changes in the specification. Unfortunately, our attempts to propose are stuck in conversations (see request for adding Resource prototypes).
In order to take the opportunity for independent developing of features we decided to make a fork and support it on our own.
- Dropped support of Resource model section and Relation section.
- Resource prototypes section definition was added. This allows you to set up common responses in one place and reuse them through the documentation.
- Import section definition was added. This allows to implement modular documentation and inject APIB files into each other.
- Definitions of Group, SubGroup and Message sections were added. This allows to describe non-HTTP interaction in a documentation.
- Schema Structures section definition was added. This allows to describe complex data structures directly in JSON Schema format.
- A few other non-significant improvements.
MIT License. See the LICENSE file.
