HeuJung
56a78e1d55
API 레퍼런스에 요청 예시(raw HTTP)·응답 예시(envelope 전문)를 표준 포맷에 편입하고, 전 대상(코어+전 모듈+전 플러그인)에 방출했다. 예시 결함 8종 (multipart·Host 마스킹·write 실측·path 치환·현실적 바디·query 반영·중복 제거·민감값 마스킹)을 스캐폴더/프로브 공용 수정으로 근본 해소했다. 추가로 검증에서 드러난 결함을 마감했다: - 응답 예시 body 의 절대 URL(페이지네이터·콜백) 호스트를 placeholder 로 마스킹(maskResponseHost) — 요청 Host 헤더만 마스킹되던 누락 보완, 확장 39건 정정 - api:docgen 커맨드 통합 테스트 신설(라우트 수집·확장 라우팅·rules 추출· 멱등 재생성·check drift) - module-routing.md URL 스킴 오류 정정(/api/admin → /api/modules) - README·cheatsheet·api-documentation 에 API 문서 커맨드/레퍼런스 진입점 반영 전 대상 3칸 완료로 api-doc-coverage 룰을 warn→error 승격.
3.8 KiB
3.8 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) 로 결정된다. |
요청 예시
POST /api/plugins/sirsoft-ckeditor5/upload HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}
Content-Type: multipart/form-data; boundary=----G7ExampleBoundary
------G7ExampleBoundary
Content-Disposition: form-data; name="upload"; filename="example.pdf"
Content-Type: application/octet-stream
(바이너리 파일 내용)
------G7ExampleBoundary--
응답 필드 (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": "이미지 파일만 업로드할 수 있습니다." } }