This repository has been archived by the owner on Nov 8, 2024. It is now read-only.
Format 1A8 Release: MSON
This release brings following new features to API Blueprint:
- Ability to describe Message-body Attributes and Data Structures
- Ability to define a Link Relation Identifier for an Action
- Allowing the user to add an URI template after the HTTP method when defining an Action.
- Support MSON-like syntax for URI Parameters section.
There are 3 types of Attribute sections in API Blueprint and each of them mean different things. They are Resource Attributes, Action Attributes and Payload Attributes
Examples
Find examples of the new features in following blueprints: Attributes, Advanced Attributes, Data Structures and Advanced Action.
Parser
As of this release the API Blueprint parser – Snow Crash – is now superseded by its "harness" – Drafter. You can use the new CLI tool Drafter to parse, lint API Blueprint format 1A8 and retrieve a JSON or YAML representations of API Blueprint AST