API Blueprint
E697372
API Blueprint is a high-level, markdown-based language and format for designing, documenting, and testing web APIs in a human- and machine-readable way.
Statements (49)
| Predicate | Object |
|---|---|
| instanceOf |
API description language
ⓘ
API specification format ⓘ markdown-based language ⓘ open source project ⓘ |
| canBeConvertedTo |
HTML documentation
ⓘ
machine-readable API formats ⓘ |
| canBeRenderedWith | API documentation generators ⓘ |
| canBeUsedWith |
API mocking servers
ⓘ
API testing tools ⓘ |
| canBeVersionControlledWith | Git NERFINISHED ⓘ |
| hasDesignGoal |
collaboration between developers and non-developers
ⓘ
readability ⓘ simplicity ⓘ support for design-first API development ⓘ tooling friendliness ⓘ |
| hasFeature |
URI templates
ⓘ
action modeling ⓘ data structures definition ⓘ error response documentation ⓘ example-driven specification ⓘ grouping of resources ⓘ inheritance of attributes via data structures ⓘ metadata sections ⓘ multiple response representations ⓘ parameter definitions ⓘ payload schemas ⓘ request and response examples ⓘ resource modeling ⓘ |
| hasPrimaryUse |
designing web APIs
ⓘ
documenting web APIs ⓘ testing web APIs ⓘ |
| hasSectionType |
API overview
ⓘ
actions ⓘ data structures ⓘ metadata headers ⓘ resource groups ⓘ resources ⓘ |
| isHumanReadable | true ⓘ |
| isLanguageAgnostic | true ⓘ |
| isMachineReadable | true ⓘ |
| isTextBased | true ⓘ |
| supports |
API design-first workflows
ⓘ
API documentation generation ⓘ API mocking ⓘ API testing ⓘ HTTP APIs ⓘ RESTful APIs ⓘ hypermedia APIs ⓘ |
| usesSyntax | Markdown NERFINISHED ⓘ |
Referenced by (1)
Full triples — surface form annotated when it differs from this entity's canonical label.