feat: add basic swagger generator scaffold #2599
Closed
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
Signed-off-by: carlclone <[email protected]>
|
We just aim to automatically generate swagger doc for REST API. The tool can be run externally and may be integrated to CI to automate API doc generation. Not to provide an API to generate swagger doc. It seems this PR add a new API endpoint, is it necessary? |
|
yes , that is better |
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.
Pull Request Description:
Linked Issue: #2532
Summary:
This pull request aims to add Swagger documentation to the codebase. However, it raises the question of whether we should exclude this feature during compile time. It is worth noting that the compiled binary size increases from 44MB to 55MB with the inclusion of this feature.
Changes:
Added Swagger documentation to the codebase.
Concerns:
Should we exclude the Swagger documentation feature during compile time to mitigate the increase in binary size?
Please review and provide feedback on this pull request.