Building APIs with Node.js

©  Caio Ribeiro Pereira 2016

Caio Ribeiro Pereira, Building APIs with Node.js , 10.1007/978-1-4842-2442-7_10

10. Documenting the API

Caio Ribeiro Pereira¹ 

(1)São Vicente - SP, São Paulo, Brazil

If you have reached this chapter and your application is working correctly—with routes to the management tasks and users, integrated with a database, and with user authentication via JSON Web Token—congratulations! You have created, following some best practices, a REST API using Node.js. If you intend to use this pilot project as a base to construct your own API, then you already have enough of an application to deploy it into a production environment.

Introduction to ApiDoc.js

In this chapter, we’ll learn how to write and generate API documentation; after ...