AX-Copilot-Codex/dist/AxCopilot/skills/api-docs.skill.md

name, label, description, icon, allowed-tools, tabs

name	label	description	icon	allowed-tools	tabs
api-docs	API 문서 생성	코드에서 API 엔드포인트를 분석하여 마크다운/HTML API 문서를 자동 생성합니다.	\uE8A1	folder_map grep file_read file_write search_codebase	code

작업 폴더의 소스 코드를 분석하여 API 문서를 생성하세요.

분석 대상

• REST API 엔드포인트 (Controller, Route 어노테이션)
• 함수/메서드 시그니처 및 주석
• 요청/응답 모델 (DTO, Schema)
• 인증/권한 요구사항

작업 절차

1. folder_map — 프로젝트 구조 파악
2. grep — API 엔드포인트 패턴 검색 ([HttpGet], @GetMapping, router.get, @app.route 등)
3. file_read — 컨트롤러/라우터 파일 분석
4. grep — 요청/응답 모델 클래스 검색
5. file_read — 모델 구조 분석
6. file_write — API 문서 생성

출력 형식

마크다운으로 작성하되 다음 구조를 따르세요:

# API 문서

## 개요
- Base URL, 인증 방식, 공통 헤더

## 엔드포인트

### [POST] /api/users
- **설명**: 사용자 생성
- **인증**: Bearer Token 필요
- **요청 본문**:
  | 필드 | 타입 | 필수 | 설명 |
  |------|------|------|------|
  | name | string | ✓ | 사용자 이름 |
- **응답**: 201 Created
  ```json
  { "id": 1, "name": "..." }

• 에러 코드: 400, 401, 409

## 주의사항
- 코드에서 실제 확인된 내용만 문서화하세요. 추측하지 마세요.
- 주석이나 Swagger/OpenAPI 어노테이션이 있으면 우선 활용하세요.
- 인증, 페이징, 에러 처리 등 공통 패턴은 별도 섹션으로 정리하세요.