Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add sync doc generation to an existing NestJS project #50

Open
inigomarquinez opened this issue Mar 22, 2023 · 0 comments
Open

Add sync doc generation to an existing NestJS project #50

inigomarquinez opened this issue Mar 22, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@inigomarquinez
Copy link
Contributor

inigomarquinez commented Mar 22, 2023

The OpenAPI specification is a language-agnostic definition format used to describe RESTful APIs. Nest provides a dedicated module which allows generating such a specification by leveraging decorators.

Apart from that, it has a plugin that enhances the TypeScript compilation process to reduce the amount of boilerplate code required.

However, this doesn't come with the default boilerplate, so it would be good to include it and also add de swagger decorators automatically to the controllers (at least for the default controller included in the scaffolding).

@inigomarquinez inigomarquinez changed the title Add sync doc generation to an existing nestjs project Add sync doc generation to an existing NestJS project Mar 22, 2023
@inigomarquinez inigomarquinez added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 22, 2023
@inigomarquinez inigomarquinez added this to the 2023 Q3 milestone Mar 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant