Skip to content

Swagger + URI Versioning Middleware Ordering Documentation #2377

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

Open
1 of 5 tasks
GalvinGao opened this issue Jun 30, 2022 · 0 comments
Open
1 of 5 tasks

Swagger + URI Versioning Middleware Ordering Documentation #2377

GalvinGao opened this issue Jun 30, 2022 · 0 comments

Comments

@GalvinGao
Copy link

GalvinGao commented Jun 30, 2022

I'm submitting a...

  • Regression
  • Bug report
  • Feature request
  • Documentation issue or request (new chapter/page)
  • Support request => Please do not submit support request here, instead post your question on Stack Overflow.

Current behavior

The current documentation does not mention how the swagger middleware needs to be ordered in relative to versioning middleware, where if the versioning middleware is invoked after the swagger middleware it would be emitting incorrect paths.

Expected behavior

The documentation should preferably document this behavior clearly in https://docs.nestjs.com/openapi/introduction#bootstrap where it mentions bootstrapping the OpenAPI docs.

Minimal reproduction of the problem with instructions

https://docs.nestjs.com/openapi/introduction#bootstrap

What is the motivation / use case for changing the behavior?

To clarify docs and avoid pitfalls experienced in nestjs/swagger#1495

Environment

For Tooling issues:

  • Node version: NA
  • Platform: NA

Others:

Relate to nestjs/swagger#1495

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