HeuJung
6c8381f164
이슈 본연: API 레퍼런스의 미채움 마커 5종(실측 제외/TODO/필드 없음/대표 에러 없음)
1,194건을 코드에서 읽어 전수 채우고(0건), api:docgen 재생성이 사람이 채운 내용을
손실·열화시키던 멱등성 결함 4종(CRLF, 표 파이프 이스케이프, 에러 서술 보존, 중복
라우트명 키)을 근본 수정. --check 를 실측 제외와 드리프트가 구분되도록 재정의.
ParameterDescriber/ResourceFieldDescriber 에 leaf 폴백·SEO 스코프·공통 사전 확장.
파생 결함(문서 실측 중 발견): ResponseHelper 기본 메시지 키 6종이 존재하지 않는
messages.* 를 가리켜 응답 message 가 번역문 대신 키 문자열로 노출되던 문제를 common.*
으로 정정하고, 코어 7 + gdpr/marketing/pay_kginicis/verification/ecommerce 확장의
호출부와 누락 lang 키(게시판 10키 + 이커머스 category_images 4키 포함)를 ko/en/ja
전수 정정. 중복 그룹 키 2건은 기존 키로 호출부 통합.
보안: GET /api/identity/challenges/{id} 는 권한 가드 없는 공개 폴링 엔드포인트인데
Service::getStatus 가 attempts/max_attempts 를 응답에 담아 남은 시도 횟수를 추론할 수
있었다. 두 필드를 제거하고, 챌린지 화면(admin_basic/basic)의 서버 attempts 참조를
제거(남은 횟수 UI 는 query fallback + verify 실패 시 로컬 증가로 유지).
부수 정리(변경셋에 들어온 board 컨트롤러의 audit 사전 결함): FormRequest 4개 신설로
base Request 주입 제거, CommentController 의 Board 직접 호출을 BoardService 위임으로
전환, PHPDoc @return 보강. board 스위트에서 발견한 stale test 3건(seed SSoT 불일치,
admin 계정 user 역할 누락)도 같은 세션에서 정정.
버전 정렬(공개 release 기준): 코어 7.0.3→7.0.4, sirsoft-board 1.0.1→1.0.2,
verification_kginicis 1.0.0→1.0.1, admin_basic 1.0.1→1.0.4.
3.6 KiB
3.6 KiB
Product Image API 레퍼런스
소유: module
sirsoft-ecommerce· 생성:php artisan api:docgen(실측 기반). @generated 블록은 재생성 시 갱신되며, 사람이 작성한 설명은 보존됩니다.
TL;DR (5초 요약)
1. 이 문서는 실제 API 호출로 실측한 Product Image 엔드포인트 레퍼런스입니다
2. 각 엔드포인트: 메서드/URI/권한 + 요청 파라미터 표 + 요청 예시(curl) + 실측 응답 필드 표 + 응답 예시(envelope)
3. 응답 필드의 예시값·응답 예시 JSON 은 실제 호출 응답에서 관측된 값입니다
4. 갱신: 코드 변경 후 php artisan api:docgen 재실행
5. 설명(TODO) 칸은 사람이 채웁니다
GET /api/modules/sirsoft-ecommerce/product-image/{hash}
- 라우트명:
api.modules.sirsoft-ecommerce.product-image.download - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Public\ProductImageController@download - 인증/권한: 공개 (인증 불필요)
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
|---|---|---|---|---|---|
| hash | path | string | 예 | — | 서빙할 상품 이미지의 URL용 고유 해시 (ecommerce_product_images.hash) |
요청 예시
GET /api/modules/sirsoft-ecommerce/product-image/{hash} HTTP/1.1
Host: api.example.com
Accept: application/json
응답 필드 (data 내부)
이 엔드포인트는 JSON 봉투(data)를 반환하지 않습니다. 성공 시 이미지 원본 파일의 바이너리 스트림(StreamedResponse)을 직접 반환합니다.
| 응답 헤더 | 값 | 용도/설명 |
|---|---|---|
| Content-Type | image/jpeg (레코드의 mime_type 값 그대로 — image/png | image/webp | image/gif 등) |
저장된 이미지의 MIME 타입 |
| Content-Disposition | attachment; filename="product-main.jpg" (레코드의 original_filename) |
업로드 당시의 원본 파일명 |
| Cache-Control | public, max-age=31536000 |
브라우저/CDN 1년 캐싱 (해시 기반 URL이므로 내용 변경 시 URL 자체가 바뀜) |
응답 예시
성공 시 JSON 이 아닌 이미지 바이너리가 스트리밍됩니다.
HTTP/1.1 200 OK
Content-Type: image/jpeg
Content-Disposition: attachment; filename="product-main.jpg"
Cache-Control: public, max-age=31536000
<binary image data>
실패(404) 시에만 JSON 봉투가 반환됩니다.
{
"success": false,
"message": "상품 이미지를 찾을 수 없습니다."
}
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 404 | Not Found | 레코드는 있으나 스토리지에 실제 파일이 없어 스트림 생성에 실패한 경우 (ProductImageService::download() null — 서버 로그에 상품 이미지 스토리지에 없음 기록) |
설명 공개 API로, 해시(hash, 12자)로 식별되는 상품 이미지 원본 파일을 스트리밍 서빙합니다. 인증이 필요 없으며(PublicBaseController), ProductImageController@download가 먼저 ProductImageService::findByHash()로 이미지 레코드 존재를 확인한 뒤 ProductImageService::download()로 StorageInterface::response() 기반 StreamedResponse를 반환합니다. 응답에는 저장된 mime_type과 Cache-Control: public, max-age=31536000(1년) 헤더가 부여되어 브라우저/CDN 캐싱에 최적화됩니다. 해시에 해당하는 레코드가 없거나 스토리지에 실제 파일이 없으면 404 에러 응답을 반환합니다.