API documentation using Swagger

We want to consider to use industry recognized Swagger to document our Express.js API and make it easier to collaborate as a team of several developers, using open-source packages swagger-ui-express and lswagger-jsdoc

We plan to explore following this guide to set it up.

Why Swagger?

One significant benefit of Swagger is that it helps to understand how API works for the client side of an application. Swagger synchronizes the API between the client and server side of the application. That way, developers who work in frontend can understand how the API works and integrate the APIs into the client side.

Another benefit of using Swagger is that it’s comprehensive for developers and non-developers. Everyone involved in product development, including product managers, stakeholders, and developers, can try out API in UI without needing to run the server independently.