Skip to content

[docs] API 문서 구조 및 관리 에이전트 도입 #317

Description

@ddingmin

목적

클라이언트 개발자와 개발 에이전트가 API 계약을 빠르게 탐색할 수 있도록 OpenAPI와 도메인별 Markdown 문서 구조를 도입합니다.

작업 내용

  • 루트 API 문서 인덱스와 도메인별 상세 문서 추가
  • SpringDoc 기반 OpenAPI 스냅샷 및 갱신·검증 스크립트 추가
  • API 변경 시 문서를 갱신하는 api-documenter 에이전트 추가
  • Codex 기능 개발 하네스의 기본 에이전트·규칙 스킬 공개 및 6개 에이전트 흐름 구성
  • feature-dev 오케스트레이터와 code-reviewer에 API 문서 갱신·검증 절차 연결
  • README와 AGENTS.md에 API 문서 관리 규칙 반영

완료 조건

  • OpenAPI YAML과 Markdown 링크 검증 통과
  • API 변경 시 문서 갱신 누락을 리뷰 단계에서 차단
  • 공개 파일에 실제 토큰, 비밀번호, 비밀키, 내부 접속 정보가 포함되지 않음

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions