API documentation question

1

JSDoc

#Documentation #Documentation As A Service & Tools #Developer Tools 49 social mentions

2

swagger.io

I would recommend looking into Swagger. You specify your entire API (models, endpoints, requests, responses, and descriptions too) and there are additional tools that understand Swagger syntax. For instance, https://readme.com lets you upload a Swagger specification and generate documentation from it. There are also tools out there to generate boilerplate code for your application as well, such as models and HTTP clients. There's a small learning curve but if you want to get started, you can search for some examples and try to modify them to fit your API.

#API Tools #APIs #Documentation 81 social mentions

3

ReadMe

I would recommend looking into Swagger. You specify your entire API (models, endpoints, requests, responses, and descriptions too) and there are additional tools that understand Swagger syntax. For instance, https://readme.com lets you upload a Swagger specification and generate documentation from it. There are also tools out there to generate boilerplate code for your application as well, such as models and HTTP clients. There's a small learning curve but if you want to get started, you can search for some examples and try to modify them to fit your API.

#Documentation #Documentation As A Service & Tools #Knowledge Base 18 social mentions