코드에만 존재하던 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 동기
3.4 KiB
3.4 KiB
Upload API 레퍼런스
소유: plugin
sirsoft-ckeditor5· 생성:php artisan api:docgen(실측 기반). @generated 블록은 재생성 시 갱신되며, 사람이 작성한 설명은 보존됩니다.
TL;DR (5초 요약)
1. 이 문서는 실제 API 호출로 실측한 Upload 엔드포인트 레퍼런스입니다
2. 각 엔드포인트: 메서드/URI/권한 + 요청 파라미터 표 + 실측 응답 필드 표
3. 응답 필드의 예시값은 실제 호출 응답에서 관측된 값입니다
4. 갱신: 코드 변경 후 php artisan api:docgen 재실행
5. 설명(TODO) 칸은 사람이 채웁니다
POST /api/plugins/sirsoft-ckeditor5/upload
- 라우트명:
api.plugins.sirsoft-ckeditor5.api.sirsoft-ckeditor5.upload - 컨트롤러:
Plugins\Sirsoft\Ckeditor5\Http\Controllers\ImageUploadController@upload - 인증/권한:
auth:sanctum
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
|---|---|---|---|---|---|
| upload | body | file | 예 | max 2048 | 에디터에 드롭/붙여넣은 이미지 파일 1개(multipart). 허용 MIME 은 jpeg,jpg,png,gif,webp, 최대 크기는 플러그인 설정 imageMaxSizeMb(기본 2MB) 로 결정된다. |
응답 필드 (data 내부)
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 422 | Unprocessable Entity | 요청 파라미터가 검증 규칙을 위반한 경우 (error.errors 에 필드별 메시지) |
설명
CKEditor5 의 SimpleUploadAdapter 가 에디터에 드롭/붙여넣은 이미지를 업로드하는 관리자 엔드포인트다. 컨트롤러가 AdminBaseController 를 상속하므로 실제 인증은 auth:sanctum 에 더해 관리자(admin) 미들웨어가 적용된다(생성기 표기는 auth:sanctum 만 노출).
- 응답 형식이 표준 envelope 가 아니다. SimpleUploadAdapter 규격상 성공 시 HTTP 201 + 최상위
{"url": "..."}, 실패 시 4xx/5xx +{"error": {"message": "..."}}를 반환한다.ResponseHelper를 쓰지 않으므로data/success필드가 없다. - 요청 파라미터: multipart body 의
upload필드(이미지 파일 1개). 허용 MIME 은jpeg,jpg,png,gif,webp, 최대 크기는 플러그인 설정imageMaxSizeMb(기본 2MB) 로 동적 결정된다. 검증 실패도 CKEditor 규격({"error":{"message":...}}, HTTP 422)으로 응답한다. - 선택 권한 게이트: query 파라미터
permission이 주어지면, 현재 사용자가 해당 권한을 갖지 못한 경우 403{"error":{"message":...}}. 에디터를 임베드하는 화면이 업로드 권한을 세분화할 때 사용한다. - 업로드 성공 시 반환하는
url은 공개 서빙 엔드포인트(GET /images/{hash})의 절대 URL 이다.
응답 예시 (성공 — CKEditor 규격, envelope 아님)
{ "url": "https://example.com/api/plugins/sirsoft-ckeditor5/images/a1b2c3d4e5f6" }
오류 예시 (검증/권한/서버 오류 공통 — HTTP 422/403/500)
{ "error": { "message": "이미지 파일만 업로드할 수 있습니다." } }