Skip to content

feat : MatchingAPI #12

Description

@kim-tea-nam

Ⅰ. 이슈 설명 (Issue Description) 매칭 시스템의 프론트엔드 연동을 위한 백엔드 API 명세서를 작성합니다. 홈 화면의 매칭 현황과 매칭 대기 화면의 실시간 상태 동기화를 위한 인터페이스를 정의합니다.

Ⅱ. 발생한 문제 (Describe what happened) 현재 매칭 도메인에 대한 구체적인 API 명세가 존재하지 않아, 프론트엔드 팀과 데이터 구조(DTO) 및 엔드포인트에 대한 합의가 필요한 상황입니다. 특히 UI에 표시되어야 할 '준비 완료(Ready)' 상태와 '학과(Major)' 정보 등의 데이터 필드 정의가 필요합니다.

Ⅲ. 기대한 동작 (Describe what you expected to happen) docs/MATCHING_API.md 파일이 생성되어야 하며, 다음 내용이 포함되어야 합니다:

  1. 매칭 요청 (POST)
  2. 매칭 대기열 상태 조회 (GET) - 홈 화면용
  3. 매칭 룸 상태 조회 (GET) - 대기 화면용 (참여자 목록, 준비 상태 포함)
  4. 준비 완료 토글 (PATCH/PUT)
  5. 매칭 취소/나가기 (DELETE)
  6. 표준 에러 코드 정의 (INVALID_STATION, ROOM_NOT_FOUND 등)

Ⅳ. 재현 방법 (How to reproduce it) (기능 제안 및 문서화 작업이므로 생략)

Ⅴ. 추가로 알아야 할 사항 (Anything else we need to know?) - docs/Documentation_Guide.md의 컨벤션을 준수해야 합니다.

  • 홈 화면 UI 로직: 산본역/금정역 대기 인원 실시간 제공 필요
  • 대기 화면 UI 로직: 방장 권한, 참여자 '학과' 표시, '준비 완료' 상태 관리 필드 필수 포함

Metadata

Metadata

Assignees

Labels

feat기능 추가

Fields

No fields configured for Feature.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions