feat(api-docs): API 레퍼런스 문서 전면화 — 추출 파이프라인·전 대상 문서화·audit 강제

코드에만 존재하던 REST API 계약(약 663 엔드포인트)을 코어/확장 책임별로
분리된 마크다운 레퍼런스로 전면 문서화한다. 674개 규모에서 수기 문서는
반드시 drift 하므로 "코드 추출 → 스캐폴딩 → 사람이 서술 채움 → 하네스가
커버리지 강제" 하이브리드로 구성했다.

추출 파이프라인 (app/Support/ApiDoc):
- ApiRouteInventory / FormRequestIntrospector / ApiEndpointProbe(실측 HTTP) /
 ResponseSchemaInferrer / ApiDocScaffolder / ColumnCommentResolver /
 ResourceFieldDescriber / ParameterDescriber
- api:docgen 커맨드(--scope/--seed/--check/--dry-run/--base-url/--user) +
 응답/파라미터 in-place 백필 커맨드 2종(재생성 없이 TODO 셀만 치환, 멱등)
- ApiDocSampleSeeder 계약 + 코어/확장 시더로 실측용 완전 샘플 멱등 생성

문서화 (실측 기반, GET read-only 실호출):
- 코어 291엔드포인트 35파일(docs/backend/api) + 규정 docs/backend/api-documentation.md
- 확장: ecommerce(231)·board(80)·page(17)·hello_module(2)·pay_kginicis(22)·
 gdpr(15)·ckeditor5(2)·marketing(2)·verification_kginicis(1)
- 표준 4구성(헤더·요청 파라미터·응답 필드·에러 표) + 엔드포인트 용도 서술
- 파라미터 용도·응답 필드 설명 셀 전수 채움(도메인 지식 수기)

하네스:
- audit 룰 api-doc-coverage — API 표면(라우트/컨트롤러/FormRequest/Resource)
 변경 시 대응 문서 미동반이면 차단. 전 대상 문서 완비로 error 승격
- file-rules 리마인더(컨트롤러/라우트 편집 시), coverage.json, dev-dashboard 카드
- docs/backend/routing.md 확장 공개 API URL 스킴 정정(/api/modules|plugins/{id})
- /AGENTS.md/docs-index 동기
This commit is contained in:
HeuJung
2026-07-08 18:22:33 +09:00
parent 49b21e788c
commit 70452745c4
131 changed files with 32105 additions and 21 deletions
+18
View File
@@ -855,6 +855,24 @@ if (isset($_GET['ajax_action'])) {
</div>
</div>
<!-- API 문서 -->
<div class="bg-slate-900/40 rounded-xl p-4 border border-slate-700/30">
<div class="flex items-center gap-2 mb-3">
<span class="text-lg">📘</span>
<span class="text-xs font-medium text-slate-200">API 문서</span>
</div>
<div class="flex flex-wrap gap-2">
<button onclick="runCommand('api:docgen --scope=core --seed')" class="inline-flex items-center gap-1.5 px-3 py-2 bg-indigo-600 hover:bg-indigo-700 text-white text-xs font-medium rounded transition-colors">
<span>코어 API 문서 생성(실측)</span>
<span class="text-[10px] opacity-60">(api:docgen --scope=core --seed)</span>
</button>
<button onclick="runCommand('api:docgen --scope=core --check')" class="inline-flex items-center gap-1.5 px-3 py-2 bg-blue-600 hover:bg-blue-700 text-white text-xs font-medium rounded transition-colors">
<span>API 문서 drift 검사</span>
<span class="text-[10px] opacity-60">(api:docgen --check)</span>
</button>
</div>
</div>
<!-- 유지보수 -->
<div class="bg-slate-900/40 rounded-xl p-4 border border-slate-700/30">
<div class="flex items-center gap-2 mb-3">