HeuJung
b5c0ec1178
관리자 상품목록을 한 페이지 여는 것만으로 그 페이지 모든 상품의 옵션이 응답에 실렸다. 같은 패턴을 저장소 전역에서 찾아 14개 목록 엔드포인트를 함께 정리했다. 근본 원인은 둘이다. Resource 가 whenLoaded 로 방어하는데 Repository 가 목록 쿼리에서 관계를 무조건 로드해 가드가 항상 참이 되는 가짜 가드, 그리고 toListArray 경량 표현을 정의해 두고도 컬렉션이 toArray 를 부르는 목록/상세 미분리다. 둘 다 응답만 보면 정상이라 오류도 경고도 없이 페이로드만 불어난다. 목록은 화면이 실제로 그리는 것만 싣는다. 개수·합계는 PHP 컬렉션 연산이 아니라 DB 집계로, 대표 1건이 필요한 곳은 관계 자체를 oldestOfMany 로 좁힌다. eager load 의 limit(1) 은 부모별이 아니라 배치 쿼리 전체에 걸려 첫 행만 값을 갖게 되므로 쓸 수 없다. 뺀 값에는 대체 경로를 먼저 만들었다. 상품 옵션은 행을 펼칠 때 배치로 불러오고(상품 수와 무관하게 쿼리 상수), 종전 동작이 필요한 호출자를 위해 ?with_options=1 등 opt-in 을 남겼다. 배송정책 국가설정과 리뷰 첨부 이미지는 소비처를 실측한 결과 화면이 실제로 그리고 있어 제거하지 않았다 — 그 소비 사실을 회귀 테스트로 고정했다. 재발 방지로 정적 검사 룰 4종과 규정 문서 항목을 함께 넣었다.
9.2 KiB
Presets API 레퍼런스
소유: module
sirsoft-ecommerce· 생성:php artisan api:docgen(실측 기반). @generated 블록은 재생성 시 갱신되며, 사람이 작성한 설명은 보존됩니다.
TL;DR (5초 요약)
1. 이 문서는 실제 API 호출로 실측한 Presets 엔드포인트 레퍼런스입니다
2. 각 엔드포인트: 메서드/URI/권한 + 요청 파라미터 표 + 요청 예시(curl) + 실측 응답 필드 표 + 응답 예시(envelope)
3. 응답 필드의 예시값·응답 예시 JSON 은 실제 호출 응답에서 관측된 값입니다
4. 갱신: 코드 변경 후 php artisan api:docgen 재실행
5. 설명(TODO) 칸은 사람이 채웁니다
GET /api/modules/sirsoft-ecommerce/admin/presets
- 라우트명:
api.modules.sirsoft-ecommerce.admin.presets.index - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\SearchPresetController@index - 인증/권한:
auth:sanctum
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
|---|---|---|---|---|---|
| target_screen | query | string | 아니오 | products, orders, coupons |
대상 검색 화면 (해당 화면의 프리셋만 조회, 미지정 시 products) |
이 엔드포인트는 확장이 파라미터를 추가할 수 있습니다 (
sirsoft-ecommerce.search_preset.list_validation_rules).
요청 예시
GET /api/modules/sirsoft-ecommerce/admin/presets?target_screen=products HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}
응답 필드 (data 내부)
응답 예시
HTTP/1.1 200
{
"success": true,
"message": "검색 프리셋 목록을 조회했습니다.",
"data": []
}
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 422 | Unprocessable Entity | 요청 파라미터가 검증 규칙을 위반한 경우 (error.errors 에 필드별 메시지) |
설명 관리자 검색 화면(상품/주문/쿠폰 등)에서 저장해 둔 검색 조건 프리셋 목록을 조회합니다. auth:sanctum 인증이 필요하며, SearchPresetService::getPresets()가 target_screen에 해당하는 프리셋을 반환합니다(미지정 시 products 화면 기준). 관리자가 자주 쓰는 필터 조합을 프리셋으로 관리해 검색 화면에서 빠르게 적용하기 위한 용도이며, 확장이 list_validation_rules 훅으로 조회 파라미터를 추가할 수 있습니다.
POST /api/modules/sirsoft-ecommerce/admin/presets
- 라우트명:
api.modules.sirsoft-ecommerce.admin.presets.store - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\SearchPresetController@store - 인증/권한:
auth:sanctum
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
|---|---|---|---|---|---|
| target_screen | body | string | 아니오 | — | 프리셋이 속할 검색 화면 (products/orders/coupons, 미지정 시 products) |
| name | body | string | 예 | max 100 | 대상의 이름/명칭 |
| conditions | body | array | 예 | — | 저장할 검색 조건 배열 (필터 필드/값 조합, 적용 시 그대로 복원됨) |
이 엔드포인트는 확장이 파라미터를 추가할 수 있습니다 (
sirsoft-ecommerce.preset.store_validation_rules).
요청 예시
POST /api/modules/sirsoft-ecommerce/admin/presets HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}
Content-Type: application/json
{
"target_screen": "예시값",
"name": "예시 이름",
"conditions": [
"예시값"
]
}
응답 필드 (data 내부)
응답 예시
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 422 | Unprocessable Entity | 요청 파라미터가 검증 규칙을 위반한 경우 (error.errors 에 필드별 메시지) |
설명 관리자 검색 화면의 새 검색 조건 프리셋을 생성합니다. auth:sanctum 인증이 필요하며, SearchPresetService::create()가 target_screen(미지정 시 products)·name(최대 100자)·conditions(검색 조건 배열)을 받아 프리셋을 저장하고 성공 시 201로 생성된 프리셋을 반환합니다. 자주 쓰는 필터 조합을 이름 붙여 저장해 재사용하기 위한 용도이며, 확장이 preset.store_validation_rules 훅으로 파라미터를 추가할 수 있습니다.
DELETE /api/modules/sirsoft-ecommerce/admin/presets/{preset}
- 라우트명:
api.modules.sirsoft-ecommerce.admin.presets.destroy - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\SearchPresetController@destroy - 인증/권한:
auth:sanctum
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
|---|---|---|---|---|---|
| preset | path | string | 예 | — | 대상 preset의 식별자 |
요청 예시
DELETE /api/modules/sirsoft-ecommerce/admin/presets/{preset} HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}
응답 필드 (data 내부)
응답 예시
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 404 | Not Found | path 파라미터에 해당하는 리소스가 없는 경우 |
설명 지정한 검색 조건 프리셋 1건을 삭제합니다. auth:sanctum 인증이 필요하며, path의 {preset}은 라우트 모델 바인딩으로 SearchPreset 모델이 주입되고 SearchPresetService::delete()가 삭제를 수행합니다. 삭제 성공 시 { "deleted": true }를 반환하며, 존재하지 않는 프리셋이면 404를 반환합니다. 더 이상 사용하지 않는 저장 검색 조합을 정리하는 용도입니다.
PUT /api/modules/sirsoft-ecommerce/admin/presets/{preset}
- 라우트명:
api.modules.sirsoft-ecommerce.admin.presets.update - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\SearchPresetController@update - 인증/권한:
auth:sanctum
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
|---|---|---|---|---|---|
| preset | path | string | 예 | — | 대상 preset의 식별자 |
| name | body | string | 예 | max 100 | 대상의 이름/명칭 |
| conditions | body | array | 예 | — | 저장할 검색 조건 배열 (필터 필드/값 조합, 적용 시 그대로 복원됨) |
| sort_order | body | integer | 아니오 | min 0 | 표시 정렬 순서 값 (작을수록 우선) |
이 엔드포인트는 확장이 파라미터를 추가할 수 있습니다 (
sirsoft-ecommerce.preset.update_validation_rules).
요청 예시
PUT /api/modules/sirsoft-ecommerce/admin/presets/{preset} HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}
Content-Type: application/json
{
"name": "예시 이름",
"conditions": [
"예시값"
],
"sort_order": 1
}
응답 필드 (data 내부)
응답 예시
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 422 | Unprocessable Entity | 요청 파라미터가 검증 규칙을 위반한 경우 (error.errors 에 필드별 메시지) |
| 404 | Not Found | path 파라미터에 해당하는 리소스가 없는 경우 |
설명 기존 검색 조건 프리셋 1건을 수정합니다. auth:sanctum 인증이 필요하며, path의 {preset}은 라우트 모델 바인딩으로 주입되고 SearchPresetService::update()가 name(최대 100자)·conditions(검색 조건 배열)·선택 sort_order(정렬 순서, 0 이상)를 반영해 저장 후 갱신된 프리셋을 반환합니다. 저장해 둔 필터 조합의 이름·조건·노출 순서를 변경하는 용도이며, 확장이 preset.update_validation_rules 훅으로 파라미터를 추가할 수 있습니다.