Add documentation to your API in Node.js

Add documentation to your API in Node.js

These days, document your API is a great idea if you:

  • Work with separated teams for backend and frontend development,
  • Have a public API,
  • Are going to hand off the project and others need to work on it without your help

In case you are working with Node.js, we like to use the solution offered by apidoc https://www.npmjs.com/package/apidoc

The documentation generated by this package is not automatic so that you’ll have to describe your API resources. This may look like a tedious process, but the level of detail gained is incredible.

The documentation is also complete and provides good usage examples. You can find it here http://apidocjs.com/

Example of documentation generated by apidoc

We hope this tool helps you to improve your development process as much as it has done for us.

. . .

Regos Dev Studio is a product development company that builds add-ons for Jira and Confluence, combined with the development of custom solutions in a variety of languages.

Don’t forget to check out our website, visit our Atlassian marketplace listing. You can also follow us on Twitter or LinkedIn and stay tuned for updates!

Leave a Reply

Your email address will not be published. Required fields are marked *