allow multiple Swagger documents (no breaking changes) #1022
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ubogdan
requested changes
Oct 11, 2021
Codecov Report
@@ Coverage Diff @@
## master #1022 +/- ##
==========================================
+ Coverage 93.29% 93.34% +0.04%
==========================================
Files 7 7
Lines 1954 1968 +14
==========================================
+ Hits 1823 1837 +14
Misses 73 73
Partials 58 58
Continue to review full report at Codecov.
|
|
@h44z Thanks for your contribution! |
h44z
added a commit
to prolicht-dev/swag
that referenced
this pull request
Oct 11, 2021
ubogdan
pushed a commit
that referenced
this pull request
Oct 12, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe the PR
Allow the registration of multiple Swagger documents with different names.
This PR does not contain any breaking changes as the method signature change is backwards compatible.
It basically solves the problems listed in #885.
Relation issue
To support multiple Swagger documents, the swagger router implementations have to be changed as well:
Additional context
The binary contains one optional extra parameter:
swag init --registrationName=custom_name.This parameter can be used to override the default registration name.