Feat : swagger @tag 기능 추가 #19
Merged
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds Swagger documentation annotations (@tag and @operation) to multiple API endpoints across different controllers to enhance API documentation and clarity. Key changes include introducing Swagger annotations in RegisterController, MemberApi, FAQApi, ViewApi, MemberAdminApi, and AdminApi, as well as a minor renaming fix for consistency in join period endpoints.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/main/java/com/gdg/homepage/landing/register/api/RegisterController.java | Added Swagger annotations for API documentation. |
| src/main/java/com/gdg/homepage/landing/member/controller/MemberApi.java | Added Swagger annotations to document member management endpoints. |
| src/main/java/com/gdg/homepage/landing/faq/controller/FAQApi.java | Introduced Swagger annotations for FAQ endpoints. |
| src/main/java/com/gdg/homepage/landing/admin/controller/ViewApi.java | Added Swagger annotations for view count API endpoint. |
| src/main/java/com/gdg/homepage/landing/admin/controller/MemberAdminApi.java | Provided Swagger annotations for member admin functionalities. |
| src/main/java/com/gdg/homepage/landing/admin/controller/AdminApi.java | Added Swagger annotations for admin-related endpoints and improved parameter naming. |
Comments suppressed due to low confidence (1)
src/main/java/com/gdg/homepage/landing/admin/controller/AdminApi.java:100
- The method name 'getAnayltics' appears to be misspelled. Consider renaming it to 'getAnalytics' for improved clarity.
public ApiResponse<AnalyticsResponse> getAnayltics() {
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.