What would you like to be added:
https://blog.bitsrc.io/a-guide-to-nestjs-swagger-configuration-dec5f183b53
Why is this needed:
For transparency of the api test coverage, declarative form of usage, etc
- Improves the experience for developers using our API;
- Decreases the amount of time spent on-boarding new users (internal developers or external partners). New users will start being productive earlier and will not depend on a person (already with the knowledge) who would need to spend slots of their time to explain how the API is design and how it works;
- Leads to good product maintenance and quicker updates. It helps your internal teams know the details of your resources, methods, and their associated requests and responses, making maintenance and updates quicker;
- Agreement on API specs for the endpoints, data, types, attributes and more. And this helps internal and external users to understand the API and know what it can do;
- The API contract can act as the central reference that keeps all the team members aligned on what your API’s objectives are, and how the API’s resources are exposed;
- Unblocks development on different sides (front-end / back-end / mobile development) due to dependencies on specification;
- Allows identifying bugs and issues in the API’s architecture when defining it with the team;
- Decreases the amount of time (and headaches!!!) spent on understanding how the API works and deciphering unexpected errors when using it.
What would you like to be added:
https://blog.bitsrc.io/a-guide-to-nestjs-swagger-configuration-dec5f183b53
Why is this needed:
For transparency of the api test coverage, declarative form of usage, etc