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

Set up OpenAPI with redocly #1593

Open
2 tasks
TangoYankee opened this issue Nov 15, 2024 · 0 comments
Open
2 tasks

Set up OpenAPI with redocly #1593

TangoYankee opened this issue Nov 15, 2024 · 0 comments

Comments

@TangoYankee
Copy link
Member

TangoYankee commented Nov 15, 2024

Acceptance criteria

  • Redocly is generating OpenAPI documentation as part of the development and build processes
  • NestJs is serving the generated OpenAPI html file at a docs path

Pitfalls

Be sure to update the ts build config to ignore the openapi folder, otherwise the build's file directory will change and break

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant