Apiary expects a single apiary.apib API definition file. For maintainability purposes, this file is built from individual files located in the src directory.
All tools and scripts are executed using Docker.
Because we split up the blueprint files, we need to combine them back into one apiary.apib file so that Apiary can render our documentation. This can be doing using the following script:
makeThere's also an included gulp file to automatically build the main file whenever you make modifications:
make watchYou can lint the apiary.apib file to make sure it's valid:
make lintIf you want to preview the output of the API Blueprint, you can run:
make previewWe have documented our API Design Guidelines. Please follow these recommendations when making a pull request.
In every pull request, the essence of the change or addition, should be documented respectively in the changes or the additions.
For additions, we list them per month, so if you start a new month, group the old records under a month header.
Changes are grouped under the version number, so make sure the current latest version is updated in the Upgrading your API version section.