Contribute to help us improve!
Are there edge cases or problems that we didn't consider? Is there a technical pitfall that we should add? Did we miss a comma in a sentence?
If you have any input for us, we would love to hear from you and appreciate every contribution. Our goal is to learn from projects for projects such that nobody has to reinvent the wheel.
Let's collect our experiences together to make room to explore the novel!
To contribute click on Contribute to this page on the toolbar.
Swagger
We can use swagger (OpenAPI) in order to describe the endpoints that our application exposes.
NestJS provides a module which will read the code of our application and will expose one endpoint where we can see the swagger.
Add swagger to a devon4node application is simple, you only need to execute the command nest g -c @devon4node/schematics swagger and it will do everything for you. The next time that you start your application, you will be able to see the swagger at /v1/api endpoint.
The swagger module can read your code in order to create the swagger definition, but sometimes you need to help him by decorating your handlers.
For more information about decorators and other behaviour about swagger module, you can see the NestJS swagger documentation page
| the OpenAPI specification that this module supports is v2.0. The OpenAPI v3.0 is not available yet by using this module. |