Skip to content

docs: api-v1-routes.md에 comments 엔드포인트 표기 (+ 댓글 통합테스트 후속) #28

Description

@cocoyoon

목표

에이전트용 API 표(docs/agent/api-v1-routes.md)에 댓글 API를 빠짐없이 기재하고, 선택적으로 댓글 도메인 실 DB 통합 테스트를 추가한다.

배경

  • Rust 라우터: packages/api-server/src/domains/comments/handlers.rsrouter() — 실제 경로는 아래와 같음.
  • 문서 docs/agent/api-v1-routes.md에는 posts/likes/saved만 있고 comments 섹션 없음.

문서에 적어야 할 실제 엔드포인트

Method Path 인증 설명
GET /api/v1/posts/{post_id}/comments 불필요(현 핸들러 기준) 댓글 목록(대댓글 트리)
POST /api/v1/posts/{post_id}/comments 필요 댓글 생성
PATCH /api/v1/comments/{comment_id} 필요 본인 댓글 수정
DELETE /api/v1/comments/{comment_id} 필요 본인 댓글 삭제

(경로 문자열은 utoipa와 Axum router() 정의와 동일하게 적을 것.)

체크리스트

  • docs/agent/api-v1-routes.mdComments 소절 추가 (위 4줄 + 설명 한 줄)
  • 필요 시 docs/agent/README.md 등 교차 링크는 최소만
  • (선택) packages/api-server/src/domains/comments/tests.rs실 DB 통합 테스트 TODO 구현 — 레포 가이드: scripts/run-integration-tests.sh, docs/TESTING.md

수용 기준

  1. 새 온보딩 개발자가 댓글 베이스 URL만 보고 Next 프록시·Orval 태그와 대조할 수 있다.
  2. (통합 테스트 선택 시) CI/로컬 스크립트에서 댓글 CRUD가 DB에 대해 검증된다.

참고 파일

  • packages/api-server/src/domains/comments/handlers.rs (라우트 단일 소스)
  • packages/web/lib/hooks/useComments.ts (웹 소비 방식)

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Fields

No fields configured for issues without a type.

Projects

Status
Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions