Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[BE] OpenAPI 3.0 스펙 문서 생성 자동화 (Swagger UI 통해 API 문서 조회) #262

Merged
merged 9 commits into from
Oct 17, 2023
Merged

[BE] OpenAPI 3.0 스펙 문서 생성 자동화 (Swagger UI 통해 API 문서 조회) #262

merged 9 commits into from
Oct 17, 2023

Conversation

Jinwook94
Copy link
Owner

@Jinwook94 Jinwook94 commented Oct 17, 2023 •
edited
Loading

배경

  • 기존에는 Spring REST Docs 사용해 API 문서 생성함
  • 다음과 같은 이유로 Swagger UI 도입 고려함
    • Swagger UI 의 Spring REST Docs 대비 장점
      • API 테스트 실행 가능
      • 가독성 더 좋음
  • 이미 작성한 컨트롤러 테스트로 Open API Spec 문서를 쉽게 생성할 수 있는 방법 알게됨 → 적용 시도
    • 다음 라이브러리 사용하면 Spring REST Docs 사용 위해서 작성한 컨트롤러 테스트를 약간만 수정해서 Open API Spec 문서를 생성할 수 있음
    • 컨트롤러 테스트만으로 Open API Spec 문서 생성하기 때문에 프로덕션 코드에 Swagger 관련 코드가 들어가지 않아도 됨

@Jinwook94
chore: Spring REST Docs 저장 경로 수정
bc18fdc
@Jinwook94
feat: restdocs-api-spec 플러그인 및 의존성 추가
27da8d8
@Jinwook94
feat: restdocs-api-spec 설정 작성
0321f71 
참고: https://github.com/ePages-de/restdocs-api-spec#openapi-301-1
@Jinwook94
feat: 컨트롤러 테스트에서 MockMvcRestDocumentationWrapper 사용하도록 수정
f7ba520 
- 참고: https://github.com/ePages-de/restdocs-api-spec#mockmvc-based-tests
@Jinwook94
feat: Swagger UI dist 폴더의 파일을 static/docs/swagger 경로로 이동
b4c1160 
1.Swagger UI Release 파일 다운로드
 https://github.com/swagger-api/swagger-ui/releases/tag/v5.9.0

2. 다운 받은 폴더의 dist 경로에 있는 파일을 resources/static/docs/swagger 경로로 이동
@Jinwook94
feat: Swagger UI index.html 파일에 Open API 3.0 스펙 파일 경로 추가
a98f32f
@Jinwook94
feat: Swagger UI에서 API 테스트 위해 allowed-origins 추가
b9a17cd 
- http://localhost:63342 (로컬 Swagger UI)
- https://api.bootme.co.kr
- https://staging.api.bootme.co.kr
@Jinwook94
feat: README 파일의 API 문서 링크 수정
ee6a10c
@Jinwook94 Jinwook94 added the feat New feature or request label Oct 17, 2023
@Jinwook94 Jinwook94 self-assigned this Oct 17, 2023
@Jinwook94 Jinwook94 linked an issue Oct 17, 2023 that may be closed by this pull request
[BE] OpenAPI 3.0 스펙 문서 생성 자동화 (Swagger UI 통해 API 문서 조회) #261
Closed
@Jinwook94 Jinwook94 merged commit 6f2e7b0 into main Oct 17, 2023
@Jinwook94 Jinwook94 deleted the issue261 branch October 17, 2023 18:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@Jinwook94 Jinwook94

Labels
feat New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[BE] OpenAPI 3.0 스펙 문서 생성 자동화 (Swagger UI 통해 API 문서 조회)
1 participant
@Jinwook94