Skip to content

Conversation

@Ssamssamukja
Copy link
Collaborator

📌 연관 이슈

🌱 PR 요약

iOS 팀에서 OpenAPI Generator를 통해 API 코드를 자동 생성할 수 있도록,
운영 서버의 OpenAPI 스펙을 CodiveAPI 레포에 자동 동기화하는 CI 파이프라인을 구성했습니다.

이 PR을 통해 백엔드 API 변경 사항이 CodiveAPI의 openapi.yaml에 자동 반영되며, iOS 팀은 항상 최신 API 스펙을 기준으로 개발할 수 있도록 하였습니다.

🛠 작업 내용

  • 운영 서버의 /v3/api-docs 엔드포인트에서 OpenAPI 스펙을 가져와 CodiveAPI 레포의 Sources/CodiveAPI/openapi.yaml로 자동 업데이트하는 GitHub Action (prod-openapi.yml)을 추가하였습니다.
  • main 브랜치에 변경 사항이 반영될 때마다 OpenAPI 스펙이 최신 상태로 동기화되도록 CI 트리거 구성하였습니다.
  • OpenAPI Generator 사용 시 안정적인 코드 생성을 위해 각 도메인의 Controller 메서드에 operationId를 명시적으로 지정하였습니다.
    • 네이밍 규칙: 도메인_함수명
    • 예: auth_login, member_getProfile
  • 기존 CodiveAPI 레포 내 다른 파일에는 영향을 주지 않고, openapi.yaml 파일만 추가/갱신되도록 구성하였습니다.

📸 스크린샷

❗️리뷰어들께

@Ssamssamukja Ssamssamukja self-assigned this Dec 30, 2025
@Ssamssamukja Ssamssamukja linked an issue Dec 30, 2025 that may be closed by this pull request
@Ssamssamukja Ssamssamukja merged commit eff1d5d into develop Dec 30, 2025
2 checks passed
@sonarqubecloud
Copy link

@Ssamssamukja Ssamssamukja deleted the feat/#175-openapi branch December 31, 2025 07:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[feat] openapi 설정

2 participants