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

feat(swagger): JSON and YAML document endpoints customizable #2273

Merged

Conversation

jcolladosp
Copy link

Same PR as #2046

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Other... Please describe:

What is the current behavior?

Right now the swagger json and yam are deployed in ${finalPath}-json and ${finalPath}-yaml, without possibility of customization:

http://localhost:3000/api-json
http://localhost:3000/api-yaml

Issue Number: #1968

What is the new behavior?

Added the options jsonDocumentUrl and yamlDocumentUrl in the interface SwaggerCustomOptions
If the option value is present, json and/or yaml documents are served in the specified url.
Furthermore, if globalPrefix is specified in the nest options, it's used as prefix for the custom urls.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@kamilmysliwiec kamilmysliwiec merged commit ad6a508 into nestjs:master Feb 6, 2023
@kamilmysliwiec
Copy link
Member

LGTM

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

Successfully merging this pull request may close these issues.

None yet

3 participants