Repository files navigation

A powerful high-level API design language for web APIs.

API Blueprint is simple and accessible to everybody involved in the API designlifecycle. Its syntax is concise yet expressive.

With API Blueprint you can quickly prototype and model APIs to be created ordescribe already deployed mission-critical APIs. From acar to thelargest Content Distribution Network (CDN) in the world.

The API Blueprint is built to encourage dialogue and collaboration betweenproject stakeholders, developers and customers at any point in the APIlifecycle. At the same time, the API Blueprinttools provide the support toachieve the goals be it API development, governance or delivery.

API Blueprint is completely open sourced under the MIT license.Anycontribution is highly appreciated.

API Blueprint language is recognized by GitHub. You cansearch for API Blueprint or use theapib language identifier forsyntax highlighting.

All it takes to describe an endpoint of your API is to write:

# GET /message+ Response200(text/plain)        Hello World!

in your favorite plain text editor.

With this blueprint you can already get amock,documentation andtest for your API before you even start coding.

To learn more about the API Blueprint syntax jump directly to theAPI Blueprint Tutorial or take a look at someexamples.

The media type for API Blueprint istext/vnd.apiblueprint.

• Tutorial
• Advanced Tutorial
• Examples
• Wiki
• Glossary of Terms
• Specification
• List of Tools
• Developers

The plans for API Blueprint are completely tracked on GitHub – see theAPI Blueprint Roadmap.

Building tools for API Blueprint is possible thanks to its machine-friendly faceprovided by API Blueprint parser.

If you are interested in building tools for API Blueprint check out theDeveloping tools for API Blueprint.

Feel free report problems or propose new ideas using the API Blueprint GitHubissues.

We use an RFC process for proposing any substantial changes to the APIBlueprint language, specification and/or parsers.

If you would like to propose a change, please consult ourRFC process.

• @apiblueprint
• Slack
• Stack Overflow
• GitHub Issues

MIT License. See theLICENSEfile.