In the future, all APIs deserve reference material. For customers to effectively use the APIs, they need reference material.
Good API reference page has:
* Title
* Short description/Intro
* Endpoint/Request
* Description (more detailed)
* Endpoint/Request
* Path parameters
* Query parameters
* Request body
* Response body
Some APIs also require:
* Authorization/security details
* Definition lists
* Examples
* Default values
Tests:
In the future, all APIs deserve reference material. For customers to effectively use the APIs, they need reference material.
Choose a place for a API reference template to exist, ideally a public location (
Docsrepo,sharedfolder)Choose best practices from existing or other content
Good API reference page has:
* Title
* Short description/Intro
* Endpoint/Request
* Description (more detailed)
* Endpoint/Request
* Path parameters
* Query parameters
* Request body
* Response body
Some APIs also require:
* Authorization/security details
* Definition lists
* Examples
* Default values
Draft template for API page
* Something that is useful, helpful to customers
* Can be generated using tools that we have
* Not too much glitter
Draft template for definition page
Tests: