Skip to content

[Docs] OpenAPI 공유용 Swagger HTML 자동 배포 #51

Description

@hywznn

한눈에 보기

서버를 직접 실행하지 않아도 팀원이 현재 main의 API 경로·요청값·응답값을
브라우저에서 확인할 수 있도록 읽기 전용 Swagger HTML을 GitHub Pages에
배포합니다.

왜 필요한가요?

현재 로컬 Swagger UI(/swagger-ui.html)는 서버를 실행한 개발자만 볼 수
있습니다. Client·AI·기획 담당자도 동일한 API 계약을 링크로 확인할 수 있어야
Notion 문서와 실제 구현의 차이를 빠르게 발견할 수 있습니다.

구현 범위

  • Spring Boot test profile에서 /v3/api-docs 추출
  • OpenAPI JSON 기본 구조 검증
  • 읽기 전용 Swagger HTML 생성
  • 실제 요청 전송과 인증 입력 비활성화
  • 운영·Staging DB 및 실제 개인정보 미사용
  • 기존 DB 문서와 하나의 GitHub Pages 사이트로 배포
  • PR Artifact로 병합 전 미리보기 제공
  • Worker 요청 DTO의 중복 camelCase·snake_case Schema 정리
  • 생성기·OpenAPI 계약 자동화 테스트 추가
  • README와 초보자용 사용법 문서 추가

결과 주소

병합 후 다음 주소에서 확인합니다.

  • Swagger HTML: https://fowoco.github.io/server/api/
  • OpenAPI JSON: https://fowoco.github.io/server/api/openapi.json

완료 기준

  • Java 전체 테스트와 문서 생성기 테스트가 통과합니다.
  • Swagger 화면에 현재 API가 표시됩니다.
  • 공유 문서에서는 Try it out과 인증 입력이 노출되지 않습니다.
  • main 병합 후 Pages 배포가 성공합니다.

Metadata

Metadata

Assignees

Labels

area:serverSpring Boot API·도메인·DB·tenant·Task Workflow 영역; Prompt·모델·Provider 구현 제외priority:P1핵심 작업 다음으로 처리할 중요 작업status:in-review구현을 마치고 리뷰 또는 병합을 기다리는 작업type:docsREADME·Wiki·API 설명 등 문서 작업type:tooling테스트·검증·CI·개발 편의 도구 작업

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions