HeuJung
70452745c4
코드에만 존재하던 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 동기
20 KiB
Extra Fee Templates API 레퍼런스
소유: module
sirsoft-ecommerce· 생성:php artisan api:docgen(실측 기반). @generated 블록은 재생성 시 갱신되며, 사람이 작성한 설명은 보존됩니다.
TL;DR (5초 요약)
1. 이 문서는 실제 API 호출로 실측한 Extra Fee Templates 엔드포인트 레퍼런스입니다
2. 각 엔드포인트: 메서드/URI/권한 + 요청 파라미터 표 + 실측 응답 필드 표
3. 응답 필드의 예시값은 실제 호출 응답에서 관측된 값입니다
4. 갱신: 코드 변경 후 php artisan api:docgen 재실행
5. 설명(TODO) 칸은 사람이 채웁니다
GET /api/modules/sirsoft-ecommerce/admin/extra-fee-templates
- 라우트명:
api.modules.sirsoft-ecommerce.admin.extra-fee-templates.index - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ExtraFeeTemplateController@index - 인증/권한:
auth:sanctum+permission:sirsoft-ecommerce.shipping-policies.read
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
|---|---|---|---|---|---|
| search | query | string | 아니오 | max 200 | 검색어 (지정한 검색 대상 필드에서 부분 일치) |
| region | query | string | 아니오 | max 100 | 지역/권역 |
| is_active | query | string | 아니오 | ``, true, false |
활성 여부 (true 활성 / false 비활성) |
| sort_by | query | string | 아니오 | id, zipcode, fee, region, is_active, created_at, updated_at |
정렬 기준 필드명 |
| sort_order | query | string | 아니오 | asc, desc |
정렬 방향 (asc 오름차순 / desc 내림차순) |
| per_page | query | integer | 아니오 | min 10, max 100 | 페이지당 항목 수 |
| page | query | integer | 아니오 | min 1 | 조회할 페이지 번호 (1부터 시작) |
응답 필드 (data 내부)
목록 응답: data.data[] 배열 항목의 필드 + data.pagination.
| 필드 | 타입 | 실측 예시값 | 용도/설명 |
|---|---|---|---|
| number | integer | 37 |
목록에서의 순번 (페이지네이션 반영 행 번호 — HasRowNumber 파생) |
| id | integer | 109 |
기본 키 (내부 식별자) |
| zipcode | string | 00000 |
추가배송비를 적용할 우편번호 (단일 또는 - 로 이은 범위) |
| fee | integer | 3000 |
해당 우편번호에 부과할 추가 배송비 (상점 기본 통화 기준 반올림) |
| fee_formatted | string | 3,000원 |
fee 값의 표시용 포맷 문자열 (통화/용량/일시 등 로케일·단위 포맷) |
| region | string | 경기 안산 풍도동 |
지역명 (도서산간 등 관리자 참고용 표시 라벨) |
| description | string | 도서산간 지역 |
설명 (다국어 필드는 로케일별 값 객체) |
| is_active | boolean | true |
active 여부 |
| created_by | null | null |
등록자 UUID (creator 관계 파생, 없으면 null) |
| updated_by | null | null |
최종 수정자 UUID (updater 관계 파생, 없으면 null) |
| created_at | string | 2026-07-07 14:47:31 |
생성 일시 |
| updated_at | string | 2026-07-07 14:47:31 |
최종 수정 일시 |
| abilities | object | {"can_create":true,"can_update":true,"can_delete":true} |
현재 사용자가 이 리소스에 수행 가능한 작업 불리언 맵 (can_update, can_delete 등 — 권한 맵 기반) |
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(sirsoft-ecommerce.shipping-policies.read)이 없는 경우 |
| 422 | Unprocessable Entity | 요청 파라미터가 검증 규칙을 위반한 경우 (error.errors 에 필드별 메시지) |
설명 관리자가 추가배송비(도서산간 등 우편번호별 할증) 템플릿 목록을 검색·필터·정렬·페이지네이션으로 조회합니다. permission:sirsoft-ecommerce.shipping-policies.read 권한이 필요하며, search·region·is_active 필터와 다양한 정렬 기준을 지원합니다. ExtraFeeTemplateService::getList()가 조회하고 통계(getStatistics())를 함께 담아 ExtraFeeTemplateCollection으로 반환합니다. 각 항목은 우편번호·추가 배송비·지역명을 포함하며 배송정책의 지역별 할증 관리 화면에 사용됩니다.
POST /api/modules/sirsoft-ecommerce/admin/extra-fee-templates
- 라우트명:
api.modules.sirsoft-ecommerce.admin.extra-fee-templates.store - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ExtraFeeTemplateController@store - 인증/권한:
auth:sanctum+permission:sirsoft-ecommerce.shipping-policies.create
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
|---|---|---|---|---|---|
| zipcode | body | string | 예 | max 20 | 우편번호 |
| fee | body | number | 예 | min 0, max 9999999999.99 | 해당 우편번호에 부과할 추가 배송비 (0 이상) |
| region | body | string | 아니오 | max 100 | 지역/권역 |
| description | body | string | 아니오 | max 1000 | 설명 |
| is_active | body | boolean | 아니오 | — | 활성 여부 (true 활성 / false 비활성) |
응답 필드 (data 내부)
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(sirsoft-ecommerce.shipping-policies.create)이 없는 경우 |
| 422 | Unprocessable Entity | 요청 파라미터가 검증 규칙을 위반한 경우 (error.errors 에 필드별 메시지) |
설명 관리자가 추가배송비 템플릿 1건을 생성합니다. permission:sirsoft-ecommerce.shipping-policies.create 권한이 필요하며, 우편번호(zipcode, 단일 또는 범위)와 추가 배송비(fee)를 필수로 받고 지역명·설명·활성 여부를 선택 입력합니다. ExtraFeeTemplateService::create()가 저장하고 생성된 템플릿을 201로 반환합니다. 활성 템플릿은 배송비 계산 시 해당 우편번호에 할증으로 반영됩니다.
GET /api/modules/sirsoft-ecommerce/admin/extra-fee-templates/active-settings
- 라우트명:
api.modules.sirsoft-ecommerce.admin.extra-fee-templates.active-settings - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ExtraFeeTemplateController@activeSettings - 인증/권한:
auth:sanctum+permission:sirsoft-ecommerce.shipping-policies.read
요청 파라미터
요청 파라미터 없음.
응답 필드 (data 내부)
| 필드 | 타입 | 실측 예시값 | 용도/설명 |
|---|---|---|---|
| zipcode | string | 00000 |
추가배송비 적용 우편번호 (배송정책 설정용 축약 필드) |
| fee | integer | 3000 |
해당 우편번호의 추가 배송비 (float 변환값) |
| region | string | `` | 지역명 (없으면 빈 문자열) |
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(sirsoft-ecommerce.shipping-policies.read)이 없는 경우 |
설명 활성화된 추가배송비 템플릿을 배송정책에서 바로 사용할 수 있는 축약 JSON 배열(우편번호·배송비·지역명)로 반환합니다. permission:sirsoft-ecommerce.shipping-policies.read 권한이 필요하며, ExtraFeeTemplateService::getAllAsExtraFeeSettings()가 is_active=true 인 템플릿만 배송정책 설정 형식으로 변환합니다. 배송정책 편집 화면에서 지역별 할증 규칙을 채우거나 계산 로직에 주입하는 용도로, 관리 목록(index)의 상세 필드 대신 계산에 필요한 최소 필드만 내려줍니다.
DELETE /api/modules/sirsoft-ecommerce/admin/extra-fee-templates/bulk
- 라우트명:
api.modules.sirsoft-ecommerce.admin.extra-fee-templates.bulk-destroy - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ExtraFeeTemplateController@bulkDestroy - 인증/권한:
auth:sanctum+permission:sirsoft-ecommerce.shipping-policies.delete
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
|---|---|---|---|---|---|
| ids | query | array | 예 | min 1 | 대상 리소스 식별자 배열 (대량 작업 대상) |
응답 필드 (data 내부)
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(sirsoft-ecommerce.shipping-policies.delete)이 없는 경우 |
| 422 | Unprocessable Entity | 요청 파라미터가 검증 규칙을 위반한 경우 (error.errors 에 필드별 메시지) |
설명 관리자가 여러 추가배송비 템플릿을 한 번에 삭제합니다. permission:sirsoft-ecommerce.shipping-policies.delete 권한이 필요하고 대상 ID 배열(ids)을 쿼리로 전달하며, ExtraFeeTemplateService::bulkDelete()가 일괄 삭제 후 삭제 건수(deleted_count)를 반환합니다. 목록에서 여러 지역 할증 규칙을 선택해 한꺼번에 정리할 때 사용합니다.
POST /api/modules/sirsoft-ecommerce/admin/extra-fee-templates/bulk
- 라우트명:
api.modules.sirsoft-ecommerce.admin.extra-fee-templates.bulk-store - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ExtraFeeTemplateController@bulkStore - 인증/권한:
auth:sanctum+permission:sirsoft-ecommerce.shipping-policies.create
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
|---|---|---|---|---|---|
| items | body | array | 예 | min 1, max 1000 | 처리 대상 항목 배열 |
응답 필드 (data 내부)
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(sirsoft-ecommerce.shipping-policies.create)이 없는 경우 |
| 422 | Unprocessable Entity | 요청 파라미터가 검증 규칙을 위반한 경우 (error.errors 에 필드별 메시지) |
설명 관리자가 CSV/엑셀 업로드로 추가배송비 템플릿을 한 번에 대량 등록합니다. permission:sirsoft-ecommerce.shipping-policies.create 권한이 필요하고 최대 1000건까지 items 배열로 전달하며, ExtraFeeTemplateService::bulkCreate()가 일괄 생성 후 등록 건수(created_count)를 201로 반환합니다. 도서산간 우편번호 목록처럼 다수의 지역 할증을 수기 입력 없이 파일로 업로드할 때 사용합니다.
PATCH /api/modules/sirsoft-ecommerce/admin/extra-fee-templates/bulk-toggle-active
- 라우트명:
api.modules.sirsoft-ecommerce.admin.extra-fee-templates.bulk-toggle-active - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ExtraFeeTemplateController@bulkToggleActive - 인증/권한:
auth:sanctum+permission:sirsoft-ecommerce.shipping-policies.update
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
|---|---|---|---|---|---|
| ids | body | array | 예 | min 1 | 대상 리소스 식별자 배열 (대량 작업 대상) |
| is_active | body | boolean | 예 | — | 활성 여부 (true 활성 / false 비활성) |
응답 필드 (data 내부)
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(sirsoft-ecommerce.shipping-policies.update)이 없는 경우 |
| 422 | Unprocessable Entity | 요청 파라미터가 검증 규칙을 위반한 경우 (error.errors 에 필드별 메시지) |
설명 관리자가 여러 추가배송비 템플릿의 활성 상태를 한 번에 지정한 값(is_active)으로 변경합니다. permission:sirsoft-ecommerce.shipping-policies.update 권한이 필요하고 대상 ID 배열(ids)과 적용할 활성 여부를 전달하며, ExtraFeeTemplateService::bulkToggleActive()가 일괄 갱신 후 변경 건수(updated_count)를 반환합니다. 단건 토글과 달리 여러 지역 할증을 한꺼번에 켜거나 끌 때 사용합니다.
DELETE /api/modules/sirsoft-ecommerce/admin/extra-fee-templates/{id}
- 라우트명:
api.modules.sirsoft-ecommerce.admin.extra-fee-templates.destroy - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ExtraFeeTemplateController@destroy - 인증/권한:
auth:sanctum+permission:sirsoft-ecommerce.shipping-policies.delete
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
|---|---|---|---|---|---|
| id | path | string | 예 | — | 대상 리소스의 식별자 |
응답 필드 (data 내부)
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(sirsoft-ecommerce.shipping-policies.delete)이 없는 경우 |
| 404 | Not Found | path 파라미터에 해당하는 리소스가 없는 경우 |
설명 관리자가 추가배송비 템플릿 1건을 삭제합니다. permission:sirsoft-ecommerce.shipping-policies.delete 권한이 필요하며, 대상이 없으면 404 를 반환하고 존재하면 ExtraFeeTemplateService::delete()가 삭제합니다. 특정 지역의 할증 규칙을 개별적으로 제거할 때 사용합니다.
GET /api/modules/sirsoft-ecommerce/admin/extra-fee-templates/{id}
- 라우트명:
api.modules.sirsoft-ecommerce.admin.extra-fee-templates.show - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ExtraFeeTemplateController@show - 인증/권한:
auth:sanctum+permission:sirsoft-ecommerce.shipping-policies.read
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
|---|---|---|---|---|---|
| id | path | string | 예 | — | 대상 리소스의 식별자 |
응답 필드 (data 내부)
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(sirsoft-ecommerce.shipping-policies.read)이 없는 경우 |
| 404 | Not Found | path 파라미터에 해당하는 리소스가 없는 경우 |
설명 관리자가 추가배송비 템플릿 1건의 상세 정보를 조회합니다. permission:sirsoft-ecommerce.shipping-policies.read 권한이 필요하며, ExtraFeeTemplateService::getDetail()이 대상을 조회해 ExtraFeeTemplateResource로 반환합니다. 템플릿 편집 폼에 기존 값(우편번호·배송비·지역명·설명·활성 여부)을 채우는 용도로 사용되며, 대상이 없으면 404 를 반환합니다.
PUT /api/modules/sirsoft-ecommerce/admin/extra-fee-templates/{id}
- 라우트명:
api.modules.sirsoft-ecommerce.admin.extra-fee-templates.update - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ExtraFeeTemplateController@update - 인증/권한:
auth:sanctum+permission:sirsoft-ecommerce.shipping-policies.update
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
|---|---|---|---|---|---|
| id | path | string | 예 | — | 대상 리소스의 식별자 |
| zipcode | body | string | 예 | max 20 | 우편번호 |
| fee | body | number | 예 | min 0, max 9999999999.99 | 해당 우편번호에 부과할 추가 배송비 (0 이상) |
| region | body | string | 아니오 | max 100 | 지역/권역 |
| description | body | string | 아니오 | max 1000 | 설명 |
| is_active | body | boolean | 아니오 | — | 활성 여부 (true 활성 / false 비활성) |
응답 필드 (data 내부)
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(sirsoft-ecommerce.shipping-policies.update)이 없는 경우 |
| 422 | Unprocessable Entity | 요청 파라미터가 검증 규칙을 위반한 경우 (error.errors 에 필드별 메시지) |
| 404 | Not Found | path 파라미터에 해당하는 리소스가 없는 경우 |
설명 관리자가 추가배송비 템플릿 1건을 전체 수정합니다. permission:sirsoft-ecommerce.shipping-policies.update 권한이 필요하며, path 의 id 로 대상을 조회해 없으면 404(messages.extra_fee_template.not_found)를 반환합니다. 존재하면 ExtraFeeTemplateService::update()가 우편번호·추가 배송비·지역명·설명·활성 여부를 갱신합니다. 우편번호와 배송비는 필수이며, 수정된 템플릿이 활성 상태이면 이후 배송비 계산에 즉시 반영됩니다.
PATCH /api/modules/sirsoft-ecommerce/admin/extra-fee-templates/{id}/toggle-active
- 라우트명:
api.modules.sirsoft-ecommerce.admin.extra-fee-templates.toggle-active - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ExtraFeeTemplateController@toggleActive - 인증/권한:
auth:sanctum+permission:sirsoft-ecommerce.shipping-policies.update
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
|---|---|---|---|---|---|
| id | path | string | 예 | — | 대상 리소스의 식별자 |
응답 필드 (data 내부)
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(sirsoft-ecommerce.shipping-policies.update)이 없는 경우 |
| 404 | Not Found | path 파라미터에 해당하는 리소스가 없는 경우 |
설명 관리자가 추가배송비 템플릿 1건의 활성 상태를 반전(active↔inactive)합니다. permission:sirsoft-ecommerce.shipping-policies.update 권한이 필요하며, path 의 id 로 대상을 조회해 없으면 404(messages.extra_fee_template.not_found)를 반환합니다. 존재하면 ExtraFeeTemplateService::toggleActive()가 현재 값을 뒤집어 저장하고 갱신된 템플릿을 반환합니다. 목록 화면에서 특정 지역 할증 규칙을 개별적으로 켜거나 끌 때 사용하며, 여러 건을 동일 값으로 일괄 설정하려면 bulk-toggle-active 엔드포인트를 사용합니다.