Expert Python Programming - Third Edition

Documentation as API prototype with API Blueprint

API Blueprint is a web API description language that is both human-readable and well-defined. You can think of it like a Markdown for web service description language. It allows documenting anything from the structure of URL paths, through body structures of HTTP request/responses and headers, to complex request-response exchanges. The following is an example of an imaginary Cat API described using API Blueprint:

FORMAT: 1AHOST: https://cats-api.example.com# Cat APIThis API Blueprint demonstrates example documentation of some imaginaryCat API.# Group PostsThis section groups Cat resources.## Cat [/cats/{cat_id}]A Cat is central and only resource utilized by Cat API.+ Parameters + cat_id: `1` ...