feat: Add Swagger index.html for gin debug/test mode #102
Conversation
This file contains hidden or 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
|
|
dongjiang1989
force-pushed
the
add-swag-config
branch
from
c7c22e6 to
3912115
Compare
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces Swagger UI for API documentation, making it available only in non-release modes. This is accomplished by adding swaggo/gin-swagger and related dependencies, and then conditionally configuring the /swagger/*any route within pkg/routers/router.go. The implementation correctly uses gin.Mode() to prevent exposing API documentation in production environments, which is a good security practice. The changes are straightforward and enhance the developer experience by providing interactive API documentation during development and testing.
Signed-off-by: dongjaing1989 <dongjiang1989@126.com> Signed-off-by: dongjiang1989 <dongjiang1989@126.com>
dongjiang1989
force-pushed
the
add-swag-config
branch
from
3912115 to
0e48953
Compare
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.
No description provided.