Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
This article represents conceptual future plans for the API Blueprint language.
The goal is for API Blueprint to be high level API description language. Simple and accessible. Focused primarily on the semantics of API's application domain, data modeling and relations. Offering high reusability through the MSON syntax and modularity.
API Blueprint must avoid forcing user to to a particular design principle (architectural style). It should – however – radically simplify the design of Hypermedia (REST) and HTTP-based APIs.
The API Blueprint should be protocol, architectural style and media type agnostic. API Blueprint files should not - by default – contain message payloads and other API description assets (JSON, XML, JSON Schema blobs).
Prioritized list of core features to be developed:
- Response based on parameter values
- Affording Actions
- MSON Parameters and Headers
- Multiple files – modularity
- External Assets
- State machine description
- Hypermedia media types
- Abstract protocol layer
- Scenarios & Testing
This list includes only the most conceptual – core – features of API Blueprint. Too see the complete list check the GitHub issues.
Use the following links to quickly access:
Everything: All language-related issues
Features: All features
Ideas: Submitted ideas
Specification: RFC proposals being implemented into the specification
Being implemented: Specification being implemented in the parser stack