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 동기
14 KiB
Product Common Infos API 레퍼런스
소유: module
sirsoft-ecommerce· 생성:php artisan api:docgen(실측 기반). @generated 블록은 재생성 시 갱신되며, 사람이 작성한 설명은 보존됩니다.
TL;DR (5초 요약)
1. 이 문서는 실제 API 호출로 실측한 Product Common Infos 엔드포인트 레퍼런스입니다
2. 각 엔드포인트: 메서드/URI/권한 + 요청 파라미터 표 + 실측 응답 필드 표
3. 응답 필드의 예시값은 실제 호출 응답에서 관측된 값입니다
4. 갱신: 코드 변경 후 php artisan api:docgen 재실행
5. 설명(TODO) 칸은 사람이 채웁니다
GET /api/modules/sirsoft-ecommerce/admin/product-common-infos
- 라우트명:
api.modules.sirsoft-ecommerce.admin.product-common-infos.index - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ProductCommonInfoController@index - 인증/권한:
auth:sanctum+permission:sirsoft-ecommerce.product-common-infos.read
요청 파라미터
요청 파라미터 없음.
응답 필드 (data 내부)
목록 응답: data.data[] 배열 항목의 필드 + data.pagination.
| 필드 | 타입 | 실측 예시값 | 용도/설명 |
|---|---|---|---|
| id | integer | 207 |
기본 키 (내부 식별자) |
| name | object | {"ko":"일반 배송 안내","en":"Standard Shipping"} |
대상의 이름/명칭 (다국어 필드는 로케일별 값 객체) |
| localized_name | string | 일반 배송 안내 |
name 의 현재 로케일 해석 값 (다국어 필드를 표시용 문자열로 해석) |
| content | object | {"ko":"• 배송 기간: 결제 완료 후 1~3일 이내 출고 (영업일 기준)\n• 배송 업체: CJ대… |
본문 내용 |
| localized_content | string | • 배송 기간: 결제 완료 후 1~3일 이내 출고 (영업일 기준) … |
content 의 현재 로케일 해석 값 (다국어 필드를 표시용 문자열로 해석) |
| content_mode | string | text |
내용 표시 모드 (text 일반 텍스트 / html HTML, 기본값 text) |
| is_default | boolean | true |
default 여부 |
| is_active | boolean | true |
active 여부 |
| sort_order | integer | 0 |
표시 정렬 순서 값 (작을수록 우선) |
| icon | string | info-circle |
아이콘 식별자 (아이콘 클래스/이름) |
| created_at | string | 2026-06-15 11:24:00 |
생성 일시 |
| updated_at | string | 2026-06-15 11:24:00 |
최종 수정 일시 |
| products_count | integer | 81 |
products 개수 (집계) |
| language_count | integer | 2 |
language 개수 (집계) |
| abilities | object | {"can_create":true,"can_update":true,"can_delete":true} |
현재 사용자가 이 리소스에 수행 가능한 작업 불리언 맵 (can_update, can_delete 등 — 권한 맵 기반) |
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(sirsoft-ecommerce.product-common-infos.read)이 없는 경우 |
설명 관리자가 상품 공통정보(배송·교환·반품 안내 등 여러 상품에 재사용되는 안내문) 목록을 조회합니다. auth:sanctum + admin + sirsoft-ecommerce.product-common-infos.read 권한이 필요하며, ProductCommonInfoController@index가 search·active_only·default_only 필터를 조립합니다. per_page가 0 이하이거나 all이면 ProductCommonInfoService::getAllCommonInfos()로 전체를 조회하고, 그 외에는 getPaginatedCommonInfos()로 페이지네이션 조회(data.pagination 포함)합니다. localized_name·localized_content는 현재 로케일로 해석된 값, products_count는 이 공통정보를 사용하는 상품 수입니다.
POST /api/modules/sirsoft-ecommerce/admin/product-common-infos
- 라우트명:
api.modules.sirsoft-ecommerce.admin.product-common-infos.store - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ProductCommonInfoController@store - 인증/권한:
auth:sanctum+permission:sirsoft-ecommerce.product-common-infos.create
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
|---|---|---|---|---|---|
| name | body | array | 예 | — | 대상의 이름/명칭 |
| content | body | array | 아니오 | — | 본문 내용 |
| content_mode | body | string | 아니오 | text, html |
내용 표시 모드 (text 일반 텍스트 / html HTML, 미지정 시 text) |
| is_default | body | boolean | 아니오 | — | 기본값 지정 여부 |
| is_active | body | boolean | 아니오 | — | 활성 여부 (true 활성 / false 비활성) |
| sort_order | body | integer | 아니오 | min 0 | 표시 정렬 순서 값 (작을수록 우선) |
이 엔드포인트는 확장이 파라미터를 추가할 수 있습니다 (
sirsoft-ecommerce.product-common-info.create_validation_rules).
응답 필드 (data 내부)
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(sirsoft-ecommerce.product-common-infos.create)이 없는 경우 |
| 422 | Unprocessable Entity | 요청 파라미터가 검증 규칙을 위반한 경우 (error.errors 에 필드별 메시지) |
설명 관리자가 새 상품 공통정보를 생성합니다. auth:sanctum + admin + sirsoft-ecommerce.product-common-infos.create 권한이 필요하며, ProductCommonInfoController@store가 ProductCommonInfoService::createCommonInfo()에 검증된 데이터를 전달해 저장합니다. name은 다국어 배열(필수), content는 다국어 안내 내용, content_mode는 text/html 중 하나이며, is_default·is_active·sort_order로 기본 사용 여부·활성 여부·정렬을 지정합니다. 확장이 sirsoft-ecommerce.product-common-info.create_validation_rules 필터로 추가 파라미터를 붙일 수 있고, 성공 시 HTTP 201을, 처리 실패 시 400 에러 응답을 반환합니다.
DELETE /api/modules/sirsoft-ecommerce/admin/product-common-infos/{id}
- 라우트명:
api.modules.sirsoft-ecommerce.admin.product-common-infos.destroy - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ProductCommonInfoController@destroy - 인증/권한:
auth:sanctum+permission:sirsoft-ecommerce.product-common-infos.delete
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
|---|---|---|---|---|---|
| id | path | string | 예 | — | 대상 리소스의 식별자 |
응답 필드 (data 내부)
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(sirsoft-ecommerce.product-common-infos.delete)이 없는 경우 |
| 404 | Not Found | path 파라미터에 해당하는 리소스가 없는 경우 |
설명 관리자가 상품 공통정보 1건을 삭제합니다. auth:sanctum + admin + sirsoft-ecommerce.product-common-infos.delete 권한이 필요하며, ProductCommonInfoController@destroy가 ProductCommonInfoService::deleteCommonInfo()를 호출해 삭제합니다. path의 id에 해당하는 공통정보가 없거나 삭제 처리 중 오류가 발생하면 각각 404/400 에러 응답을 반환합니다. 여러 상품에서 참조 중인 공통정보를 삭제할 경우 노출에 영향을 줄 수 있으므로 products_count를 먼저 확인하는 것이 좋습니다.
GET /api/modules/sirsoft-ecommerce/admin/product-common-infos/{id}
- 라우트명:
api.modules.sirsoft-ecommerce.admin.product-common-infos.show - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ProductCommonInfoController@show - 인증/권한:
auth:sanctum+permission:sirsoft-ecommerce.product-common-infos.read
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
|---|---|---|---|---|---|
| id | path | string | 예 | — | 대상 리소스의 식별자 |
응답 필드 (data 내부)
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(sirsoft-ecommerce.product-common-infos.read)이 없는 경우 |
| 404 | Not Found | path 파라미터에 해당하는 리소스가 없는 경우 |
설명 관리자가 상품 공통정보 1건의 상세를 조회합니다. auth:sanctum + admin + sirsoft-ecommerce.product-common-infos.read 권한이 필요하며, ProductCommonInfoController@show가 ProductCommonInfoService::getCommonInfo()로 단건을 조회합니다. 다국어 원본(name, content)과 현재 로케일 해석값(localized_name, localized_content), content_mode, 기본/활성 여부를 함께 반환하며, 해당 id의 공통정보가 없으면 404를 반환합니다. 주로 수정 화면 진입 시 기존 값을 불러오는 데 사용됩니다.
PUT /api/modules/sirsoft-ecommerce/admin/product-common-infos/{id}
- 라우트명:
api.modules.sirsoft-ecommerce.admin.product-common-infos.update - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ProductCommonInfoController@update - 인증/권한:
auth:sanctum+permission:sirsoft-ecommerce.product-common-infos.update
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
|---|---|---|---|---|---|
| id | path | string | 예 | — | 대상 리소스의 식별자 |
| name | body | array | 예 | — | 대상의 이름/명칭 |
| content | body | array | 아니오 | — | 본문 내용 |
| content_mode | body | string | 아니오 | text, html |
내용 표시 모드 (text 일반 텍스트 / html HTML, 미지정 시 text) |
| is_default | body | boolean | 아니오 | — | 기본값 지정 여부 |
| is_active | body | boolean | 아니오 | — | 활성 여부 (true 활성 / false 비활성) |
| sort_order | body | integer | 아니오 | min 0 | 표시 정렬 순서 값 (작을수록 우선) |
이 엔드포인트는 확장이 파라미터를 추가할 수 있습니다 (
sirsoft-ecommerce.product-common-info.update_validation_rules).
응답 필드 (data 내부)
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(sirsoft-ecommerce.product-common-infos.update)이 없는 경우 |
| 422 | Unprocessable Entity | 요청 파라미터가 검증 규칙을 위반한 경우 (error.errors 에 필드별 메시지) |
| 404 | Not Found | path 파라미터에 해당하는 리소스가 없는 경우 |
설명 관리자가 상품 공통정보 1건을 수정합니다. auth:sanctum + admin + sirsoft-ecommerce.product-common-infos.update 권한이 필요하며, ProductCommonInfoController@update가 ProductCommonInfoService::updateCommonInfo()에 검증된 데이터를 전달해 갱신합니다. name(다국어 배열)은 필수이고 content·content_mode·is_default·is_active·sort_order를 함께 변경할 수 있습니다. 확장이 sirsoft-ecommerce.product-common-info.update_validation_rules 필터로 파라미터를 추가할 수 있으며, 대상이 없거나 처리 실패 시 각각 404/400 에러 응답을 반환합니다.
PATCH /api/modules/sirsoft-ecommerce/admin/product-common-infos/{id}/toggle-active
- 라우트명:
api.modules.sirsoft-ecommerce.admin.product-common-infos.toggle-active - 컨트롤러:
Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\ProductCommonInfoController@toggleActive - 인증/권한:
auth:sanctum+permission:sirsoft-ecommerce.product-common-infos.update
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
|---|---|---|---|---|---|
| id | path | string | 예 | — | 대상 리소스의 식별자 |
응답 필드 (data 내부)
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(sirsoft-ecommerce.product-common-infos.update)이 없는 경우 |
| 404 | Not Found | path 파라미터에 해당하는 리소스가 없는 경우 |
설명 관리자가 상품 공통정보의 활성/비활성 상태를 한 번의 요청으로 토글합니다. auth:sanctum + admin + sirsoft-ecommerce.product-common-infos.update 권한이 필요하며, ProductCommonInfoController@toggleActive가 ProductCommonInfoService::toggleActive()를 호출해 현재 is_active 값을 반전시킵니다. 반전 결과에 따라 활성화/비활성화 메시지를 구분해 응답하므로 목록 화면의 스위치 조작에 적합합니다. 대상이 없거나 처리 실패 시 각각 404/400 에러 응답을 반환합니다.