Documenting an API standard

[aaronrussellHO]

What is the standard you are suggesting?
Documenting an API is an important part of the software design lifecycle. It helps consumers of your API, the wider community and even your own team understand the purpose of endpoints, what and how they work, inputs and outputs etc.

What would be the benefit to the Home Office of adopting this standard?
This would help developers understand how to best help API consumers to use an API. This includes both internal teams as well as wider organisations.

How might people follow it
The documenting standard will overview techniques such as using appropriate methods,

Please confirm the below

• I have looked at the writing-a-standard standard and think this would meet the standard
• I have looked through our existing standards and think this is not covered elsewhere
• I have checked through the open issues on the repository and this standard has not already been suggested