This article represents tips on how to write documentation for APIs which are going to be published to developers, both internal and external. It touches upon some of the important areas/points that needed to be included in API documentation such that developers find it easy enough to work with APIs. Please feel free to comment/suggest if I missed to mention one or more important points. Also, sorry for the typos.
3 Areas to Cover while doing API Documentation
- Landing page which provides details such as high level information of APIs, links to APIs pages, release information, changelog details
- A summary page providing an overview on APIs in general, list of API names and one liner for each of the APIs
- One page each for each of the APIs where following details could be included:
- API Description providing details on some of the following:
- Functional details including information on what API accomplishes
- API syntax including method signature and request, response parameters
- Request and response parameters such as parameters’ description, data type, mandatory or optional information
- Exception details including error codes, what do they mean and how to handle them.
- One or more code examples which could be used by developers when integrating with APIs
- Related APIs which are used along with this API or which provide greater details in relation with functioning of the API
- References, if any, to get further details about APIs
- API Description providing details on some of the following:
Ajitesh Kumar
Ajitesh has been recently working in the area of AI and machine learning. Currently, his research area includes Safe & Quality AI. In addition, he is also passionate about various different technologies including programming languages such as Java/JEE, Javascript and technologies such as Blockchain, mobile computing, cloud-native technologies, application security, cloud computing platforms, big data etc.
He has also authored the book, Building Web Apps with Spring 5 and Angular.
He has also authored the book, Building Web Apps with Spring 5 and Angular.
Latest posts by Ajitesh Kumar (see all)
- When not to use F-Statistics for Multi-linear Regression - July 16, 2019
- R-Squared Explained for Indian Grandma - July 14, 2019
- Machine Learning – Cloud-native Model Deployments - June 29, 2019
