Repository navigation
[feature] OpenAPI(Swagger) API 문서 도입 - #170
Merged
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
요약
Notion으로 관리하던 API 계약을 springdoc-openapi 기반 문서로 전환한다. 운영(prod)에서는 비활성화한다.
What — 무엇을 바꿨나
OpenApiConfig(JWT bearerAuth) 설정Why — 왜 필요한가
수기 문서는 코드와 어긋나기 쉽다. 코드 기반 자동 문서로 항상 최신 상태를 유지한다.
How — 어떻게 구현했나
Spring Boot 3.4(MVC) 기준 springdoc-openapi-starter-webmvc-ui 사용.
ApiResponse<T>래퍼가 스키마에 자동 반영되어 1단계는 인프라 세팅만 진행.체크리스트
./gradlew test)관련 이슈
기타 / 리뷰 포인트
/swagger-ui.html,/v3/api-docs@Tag/@Operation상세화는 2단계로 별도 이슈 분리 예정