Skip to content

MatchingAPI docs 작성#10

Merged
kim-tea-nam merged 3 commits into
devfrom
docs/MatchingAPI-#8
Jan 5, 2026
Merged

MatchingAPI docs 작성#10
kim-tea-nam merged 3 commits into
devfrom
docs/MatchingAPI-#8

Conversation

@kim-tea-nam

Copy link
Copy Markdown

Ⅰ. PR 내용 설명

  • 신규 문서 생성: docs/MatchingAPI_v0_0_1.md (매칭 API v0.0.1, 문서 최초 생성)
  • 포함 내용: 엔드포인트 목록 및 요청/응답 예시, 실패 케이스(상태코드, 에러코드, 메시지, 설명), 공통 도메인 특화 오류 코드 목록 (INVALID_STATION, ALREADY_MATCHING, ROOM_NOT_FOUND, CANNOT_READY, NOT_ALL_READY, NOT_ENOUGH_MEMBERS, FORBIDDEN, UNAUTHORIZED, PARTICIPANT_NOT_FOUND 등)
  • 기능 변경 없음(문서 신규 추가)

Ⅱ. 관련 이슈

Ⅲ. 검증 방법

  1. docs/MatchingAPI_v0_0_1.md 파일이 프로젝트에 생성되었는지 확인.
  2. 각 엔드포인트별 요청/응답 예시 및 실패 케이스가 기재되었는지 확인.
  3. 에러 코드 이름이 백엔드 구현과 일치하는지 IntelliJ에서 전체 검색으로 검증.
  4. Markdown 렌더링(프리뷰)으로 표/코드블럭 표시 확인.

Ⅳ. 리뷰 시 참고 사항

  • 문서 최초 생성이므로 서비스 동작에는 영향 없음.
  • 리뷰어는 에러 코드 및 메시지 정합성, 누락된 실패 케이스(레이트리밋, 동시성, 토큰 만료 등)를 중점 확인.
  • 향후 백엔드 변경 시 문서 동기화 필요.

jihun4452 and others added 3 commits December 15, 2025 00:30
* feat: sonarcloud 추가설정 및 yml추가 #2

* chore: sonarcloud.yml 워크플로우 브랜치 이름 변경 #2

* chore: sonarcloud 버전이 gradle 8버전과 맞지않아 변경 #2

* chore: Gradle 8.10으로 다운그레이드 #2
@kim-tea-nam kim-tea-nam self-assigned this Dec 28, 2025
@kim-tea-nam kim-tea-nam added docs 문서 수정 chore 자잘한 기능 수정 labels Dec 28, 2025
@kim-tea-nam kim-tea-nam changed the base branch from master to dev December 28, 2025 06:49
@sonarqubecloud

Copy link
Copy Markdown

@jihun4452

Copy link
Copy Markdown
Contributor

좋습니다 이대로 가시죠~

@kim-tea-nam kim-tea-nam merged commit dc6ee12 into dev Jan 5, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore 자잘한 기능 수정 docs 문서 수정

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: MatchingAPI

2 participants