HeuJung
b5c0ec1178
관리자 상품목록을 한 페이지 여는 것만으로 그 페이지 모든 상품의 옵션이 응답에 실렸다. 같은 패턴을 저장소 전역에서 찾아 14개 목록 엔드포인트를 함께 정리했다. 근본 원인은 둘이다. Resource 가 whenLoaded 로 방어하는데 Repository 가 목록 쿼리에서 관계를 무조건 로드해 가드가 항상 참이 되는 가짜 가드, 그리고 toListArray 경량 표현을 정의해 두고도 컬렉션이 toArray 를 부르는 목록/상세 미분리다. 둘 다 응답만 보면 정상이라 오류도 경고도 없이 페이로드만 불어난다. 목록은 화면이 실제로 그리는 것만 싣는다. 개수·합계는 PHP 컬렉션 연산이 아니라 DB 집계로, 대표 1건이 필요한 곳은 관계 자체를 oldestOfMany 로 좁힌다. eager load 의 limit(1) 은 부모별이 아니라 배치 쿼리 전체에 걸려 첫 행만 값을 갖게 되므로 쓸 수 없다. 뺀 값에는 대체 경로를 먼저 만들었다. 상품 옵션은 행을 펼칠 때 배치로 불러오고(상품 수와 무관하게 쿼리 상수), 종전 동작이 필요한 호출자를 위해 ?with_options=1 등 opt-in 을 남겼다. 배송정책 국가설정과 리뷰 첨부 이미지는 소비처를 실측한 결과 화면이 실제로 그리고 있어 제거하지 않았다 — 그 소비 사실을 회귀 테스트로 고정했다. 재발 방지로 정적 검사 룰 4종과 규정 문서 항목을 함께 넣었다.
8.8 KiB
Options API 레퍼런스
소유: module
sirsoft-ecommerce· 생성:php artisan api:docgen(실측 기반). @generated 블록은 재생성 시 갱신되며, 사람이 작성한 설명은 보존됩니다.
TL;DR (5초 요약)
1. 이 문서는 실제 API 호출로 실측한 Options 엔드포인트 레퍼런스입니다
2. 각 엔드포인트: 메서드/URI/권한 + 요청 파라미터 표 + 요청 예시(curl) + 실측 응답 필드 표 + 응답 예시(envelope)
3. 응답 필드의 예시값·응답 예시 JSON 은 실제 호출 응답에서 관측된 값입니다
4. 갱신: 코드 변경 후 php artisan api:docgen 재실행
5. 설명(TODO) 칸은 사람이 채웁니다
PATCH /api/modules/sirsoft-ecommerce/admin/options/bulk-price
- 라우트명:
api.modules.sirsoft-ecommerce.admin.options.bulk-price - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ProductOptionController@bulkUpdatePrice - 인증/권한:
auth:sanctum+permission:sirsoft-ecommerce.products.update
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
|---|---|---|---|---|---|
| product_ids | body | array | 아니오 | — | product 식별자 배열 |
| option_ids | body | array | 아니오 | — | option 식별자 배열 |
| method | body | string | 예 | increase, decrease, fixed |
가격 변경 방식 (increase 인상 / decrease 인하 / fixed 고정가로 설정) |
| value | body | number | 예 | min 0 | 값 |
| unit | body | string | 예 | won, percent |
변경 단위 (won 금액 기준 / percent 비율 기준) |
이 엔드포인트는 확장이 파라미터를 추가할 수 있습니다 (
sirsoft-ecommerce.product_option.bulk_price_validation_rules).
요청 예시
PATCH /api/modules/sirsoft-ecommerce/admin/options/bulk-price HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}
Content-Type: application/json
{
"product_ids": [
"예시값"
],
"option_ids": [
"예시값"
],
"method": "increase",
"value": 1,
"unit": "won"
}
응답 필드 (data 내부)
응답 예시
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(sirsoft-ecommerce.products.update)이 없는 경우 |
| 422 | Unprocessable Entity | 요청 파라미터가 검증 규칙을 위반한 경우 (error.errors 에 필드별 메시지) |
설명 선택한 상품/옵션의 판매가를 일괄 변경합니다. auth:sanctum + sirsoft-ecommerce.products.update 권한이 필요하며, ProductOptionService::bulkUpdatePriceByMixedIds()가 처리합니다. product_ids는 해당 상품의 모든 옵션을, option_ids는 "productId-optionId" 형식으로 개별 선택된 옵션을 대상으로 합니다. method(increase/decrease/fixed)와 unit(won/percent) 조합으로 인상·인하·고정가를 적용하며, 검증 실패 시 422, 그 외 오류 시 500을 반환합니다. sirsoft-ecommerce.product_option.bulk_price_validation_rules 필터로 확장이 검증 규칙을 추가할 수 있습니다.
PATCH /api/modules/sirsoft-ecommerce/admin/options/bulk-stock
- 라우트명:
api.modules.sirsoft-ecommerce.admin.options.bulk-stock - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ProductOptionController@bulkUpdateStock - 인증/권한:
auth:sanctum+permission:sirsoft-ecommerce.products.update
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
|---|---|---|---|---|---|
| product_ids | body | array | 아니오 | — | product 식별자 배열 |
| option_ids | body | array | 아니오 | — | option 식별자 배열 |
| method | body | string | 예 | increase, decrease, set |
재고 변경 방식 (increase 증가 / decrease 감소 / set 특정 수량으로 설정) |
| value | body | integer | 예 | min 0 | 값 |
이 엔드포인트는 확장이 파라미터를 추가할 수 있습니다 (
sirsoft-ecommerce.product_option.bulk_stock_validation_rules).
요청 예시
PATCH /api/modules/sirsoft-ecommerce/admin/options/bulk-stock HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}
Content-Type: application/json
{
"product_ids": [
"예시값"
],
"option_ids": [
"예시값"
],
"method": "increase",
"value": 1
}
응답 필드 (data 내부)
응답 예시
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(sirsoft-ecommerce.products.update)이 없는 경우 |
| 422 | Unprocessable Entity | 요청 파라미터가 검증 규칙을 위반한 경우 (error.errors 에 필드별 메시지) |
설명 선택한 상품/옵션의 재고를 일괄 변경합니다. auth:sanctum + sirsoft-ecommerce.products.update 권한이 필요하며, ProductOptionService::bulkUpdateStockByMixedIds()가 처리합니다. product_ids는 해당 상품의 모든 옵션을, option_ids는 "productId-optionId" 형식으로 개별 선택된 옵션을 대상으로 합니다. method(increase/decrease/set)와 정수 value로 재고를 가감하거나 특정 수량으로 설정하며, 검증 실패 시 422, 그 외 오류 시 500을 반환합니다. sirsoft-ecommerce.product_option.bulk_stock_validation_rules 필터로 확장이 검증 규칙을 추가할 수 있습니다.
PATCH /api/modules/sirsoft-ecommerce/admin/options/bulk-update
- 라우트명:
api.modules.sirsoft-ecommerce.admin.options.bulk-update - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ProductOptionController@bulkUpdate - 인증/권한:
auth:sanctum+permission:sirsoft-ecommerce.products.update
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
|---|---|---|---|---|---|
| ids | body | array | 예 | min 1 | 대상 리소스 식별자 배열 (대량 작업 대상) |
| bulk_changes | body | array | 아니오 | — | 옵션 일괄 변경 조건 (price_adjustment/stock_quantity 각각 method+value, 설정된 필드가 개별 수정보다 우선 적용) |
| items | body | array | 아니오 | — | 처리 대상 항목 배열 |
이 엔드포인트는 확장이 파라미터를 추가할 수 있습니다 (
sirsoft-ecommerce.option.bulk_update_validation_rules).
요청 예시
PATCH /api/modules/sirsoft-ecommerce/admin/options/bulk-update HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}
Content-Type: application/json
{
"ids": [
"예시값"
],
"bulk_changes": [
"예시값"
],
"items": [
"예시값"
]
}
응답 필드 (data 내부)
응답 예시
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(sirsoft-ecommerce.products.update)이 없는 경우 |
| 422 | Unprocessable Entity | 요청 파라미터가 검증 규칙을 위반한 경우 (error.errors 에 필드별 메시지) |
설명 옵션들을 통합 일괄 업데이트합니다. auth:sanctum + sirsoft-ecommerce.products.update 권한이 필요하며, 상품은 미선택하고 옵션만 선택된 경우에 사용됩니다. ids(대상 옵션, 최소 1개)와 함께 bulk_changes(일괄 변경 조건)와 items(개별 인라인 수정)를 받아 ProductOptionService::bulkUpdate()가 처리하며, 일괄 변경 조건이 설정된 필드가 우선 적용되고 나머지는 개별 수정이 반영됩니다. 검증 실패 시 422, 그 외 오류 시 500을 반환하고, sirsoft-ecommerce.option.bulk_update_validation_rules 필터로 확장이 검증 규칙을 추가할 수 있습니다.