한눈에 보기
서버를 직접 실행하지 않아도 팀원이 현재 main의 API 경로·요청값·응답값을
브라우저에서 확인할 수 있도록 읽기 전용 Swagger HTML을 GitHub Pages에
배포합니다.
왜 필요한가요?
현재 로컬 Swagger UI(/swagger-ui.html)는 서버를 실행한 개발자만 볼 수
있습니다. Client·AI·기획 담당자도 동일한 API 계약을 링크로 확인할 수 있어야
Notion 문서와 실제 구현의 차이를 빠르게 발견할 수 있습니다.
구현 범위
결과 주소
병합 후 다음 주소에서 확인합니다.
- 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 배포가 성공합니다.
한눈에 보기
서버를 직접 실행하지 않아도 팀원이 현재
main의 API 경로·요청값·응답값을브라우저에서 확인할 수 있도록 읽기 전용 Swagger HTML을 GitHub Pages에
배포합니다.
왜 필요한가요?
현재 로컬 Swagger UI(
/swagger-ui.html)는 서버를 실행한 개발자만 볼 수있습니다. Client·AI·기획 담당자도 동일한 API 계약을 링크로 확인할 수 있어야
Notion 문서와 실제 구현의 차이를 빠르게 발견할 수 있습니다.
구현 범위
/v3/api-docs추출결과 주소
병합 후 다음 주소에서 확인합니다.
https://fowoco.github.io/server/api/https://fowoco.github.io/server/api/openapi.json완료 기준
Try it out과 인증 입력이 노출되지 않습니다.main병합 후 Pages 배포가 성공합니다.