Documenting APIs is incredibly useful whether you intend the API to be consumed internally by other teams in your company, external users, or even only yourself. You will thank yourself for spending the time to document the operations of the API and keep this up to date. Keeping documentation up to date should not be an arduous task. There are many applications that can generate documentation automatically from your source code, so all you need to do is run this application as part of your build workflow.
Documenting APIs
REST based-based APIs
Currently three primary standards are fighting it out to become the queen of REST API documentation:
- Swagger
- API Blueprint
- RAML
