Skip to content
This repository has been archived by the owner on Dec 3, 2019. It is now read-only.

Documenting an API Endpoint

Harry Levine edited this page Jan 2, 2018 · 3 revisions

We use Apiary for our API documentation, API mocking server, etc.

The API blueprint file is located at /operationcode_backend/apiary.apib, and our live API documentation itself is located at http://docs.operationcodeapi.apiary.io/

Please ensure that any PRs that change the behavior of the API are updated in the documentation as well. To do so:

  1. Create a free account at apiary.io
  2. Make your additions in the repository's apiary.apib file in your text editor
  3. The API endpoints are alphabetized (first by model, then by action) - all additions should be placed accordingly
  4. Cut & paste the whole file into the apiary editor to confirm that all of these changes do not create any semantic issues
  5. Repeat until there are no semantic errors
  6. Commit the apiary.apib file as part of a normal commit in your pull request