HeuJung
b5c0ec1178
관리자 상품목록을 한 페이지 여는 것만으로 그 페이지 모든 상품의 옵션이 응답에 실렸다. 같은 패턴을 저장소 전역에서 찾아 14개 목록 엔드포인트를 함께 정리했다. 근본 원인은 둘이다. Resource 가 whenLoaded 로 방어하는데 Repository 가 목록 쿼리에서 관계를 무조건 로드해 가드가 항상 참이 되는 가짜 가드, 그리고 toListArray 경량 표현을 정의해 두고도 컬렉션이 toArray 를 부르는 목록/상세 미분리다. 둘 다 응답만 보면 정상이라 오류도 경고도 없이 페이로드만 불어난다. 목록은 화면이 실제로 그리는 것만 싣는다. 개수·합계는 PHP 컬렉션 연산이 아니라 DB 집계로, 대표 1건이 필요한 곳은 관계 자체를 oldestOfMany 로 좁힌다. eager load 의 limit(1) 은 부모별이 아니라 배치 쿼리 전체에 걸려 첫 행만 값을 갖게 되므로 쓸 수 없다. 뺀 값에는 대체 경로를 먼저 만들었다. 상품 옵션은 행을 펼칠 때 배치로 불러오고(상품 수와 무관하게 쿼리 상수), 종전 동작이 필요한 호출자를 위해 ?with_options=1 등 opt-in 을 남겼다. 배송정책 국가설정과 리뷰 첨부 이미지는 소비처를 실측한 결과 화면이 실제로 그리고 있어 제거하지 않았다 — 그 소비 사실을 회귀 테스트로 고정했다. 재발 방지로 정적 검사 룰 4종과 규정 문서 항목을 함께 넣었다.
8.0 KiB
8.0 KiB
Permissions API 레퍼런스
소유: 코어 · 생성:
php artisan api:docgen(실측 기반). @generated 블록은 재생성 시 갱신되며, 사람이 작성한 설명은 보존됩니다.
TL;DR (5초 요약)
1. 이 문서는 실제 API 호출로 실측한 Permissions 엔드포인트 레퍼런스입니다
2. 각 엔드포인트: 메서드/URI/권한 + 요청 파라미터 표 + 요청 예시(curl) + 실측 응답 필드 표 + 응답 예시(envelope)
3. 응답 필드의 예시값·응답 예시 JSON 은 실제 호출 응답에서 관측된 값입니다
4. 갱신: 코드 변경 후 php artisan api:docgen 재실행
5. 설명(TODO) 칸은 사람이 채웁니다
GET /api/admin/permissions
- 라우트명:
api.admin.permissions.index - 컨트롤러:
App\Http\Controllers\Api\Admin\PermissionController@index - 인증/권한:
auth:sanctum+permission:core.permissions.read
요청 파라미터
요청 파라미터 없음.
요청 예시
GET /api/admin/permissions HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}
응답 필드 (data 내부)
목록 응답: data.data[] 배열 항목의 필드.
| 필드 | 타입 | 실측 예시값 | 용도/설명 |
|---|---|---|---|
| admin | object | {"label":"관리자 권한","icon":"cog","permissions":[{"id":1799,… |
관리자(admin) 타입 권한 그룹. label·icon(PermissionType::Admin 의 label()/icon() 산물)과 admin 타입으로 필터링된 권한 트리(permissions)를 담는다. |
| user | object | {"label":"사용자 권한","icon":"user","permissions":[{"id":1715… |
사용자(user) 타입 권한 그룹. label·icon(PermissionType::User 의 label()/icon() 산물)과 user 타입으로 필터링된 권한 트리(permissions)를 담는다. |
응답 예시
HTTP/1.1 200
{
"success": true,
"message": "권한 정보를 성공적으로 가져왔습니다.",
"data": {
"data": {
"0": "... (총 4건 중 2건 표시)",
"permissions": {
"admin": {
"label": "관리자 권한",
"icon": "cog",
"permissions": [
{
"id": 1799,
"identifier": "sirsoft-ecommerce.coupons.read",
"name": "sirsoft-ecommerce.coupons.read",
"name_raw": {
"ko": "sirsoft-ecommerce.coupons.read",
"en": "sirsoft-ecommerce.coupons.read"
},
"description": "sirsoft-ecommerce.coupons.read",
"...": "(9개 키 생략, 총 14개)"
},
{
"id": 1810,
"identifier": "core.plugins.manage",
"name": "core.plugins.manage",
"name_raw": {
"ko": "core.plugins.manage",
"en": "core.plugins.manage"
},
"description": "core.plugins.manage",
"...": "(9개 키 생략, 총 14개)"
},
{
"id": 1811,
"identifier": "sirsoft-gdpr.consent-log.read",
"name": "sirsoft-gdpr.consent-log.read",
"name_raw": {
"ko": "sirsoft-gdpr.consent-log.read",
"en": "sirsoft-gdpr.consent-log.read"
},
"description": "sirsoft-gdpr.consent-log.read",
"...": "(9개 키 생략, 총 14개)"
},
{
"id": 1715,
"identifier": "core",
"name": "코어",
"name_raw": {
"ko": "코어",
"en": "Core",
"ja": "コア"
},
"description": "코어 시스템 권한",
"...": "(9개 키 생략, 총 14개)"
},
{
"id": 1808,
"identifier": "apidoc-sample.parent",
"name": "API 문서 샘플 권한",
"name_raw": {
"ko": "API 문서 샘플 권한",
"en": "API Doc Sample Permission"
},
"description": "문서 실측용 권한",
"...": "(9개 키 생략, 총 14개)"
},
"... (총 14건 중 5건 표시)"
]
},
"user": {
"label": "사용자 권한",
"icon": "user",
"permissions": [
{
"id": 1715,
"identifier": "core",
"name": "코어",
"name_raw": {
"ko": "코어",
"en": "Core",
"ja": "コア"
},
"description": "코어 시스템 권한",
"...": "(9개 키 생략, 총 14개)"
},
{
"id": 1468,
"identifier": "sirsoft-board",
"name": "게시판",
"name_raw": {
"ko": "게시판",
"en": "Board"
},
"description": "게시판 모듈 권한",
"...": "(9개 키 생략, 총 14개)"
},
{
"id": 1489,
"identifier": "sirsoft-ecommerce",
"name": "이커머스",
"name_raw": {
"ko": "이커머스",
"en": "Ecommerce"
},
"description": "이커머스 모듈 권한",
"...": "(9개 키 생략, 총 14개)"
}
]
}
},
"types": [
"admin",
"user"
]
}
}
}
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(core.permissions.read)이 없는 경우 |
설명
시스템의 전체 권한을 계층형 트리로 조회한다. 역할 생성·편집 화면(admin_role_form.json)의 권한 선택 트리를 채우는 데 사용된다. 권한은 모듈 → 카테고리 → 개별 권한 순으로 중첩되며(각 노드의 children), 코어 권한이 먼저 오도록 정렬된다. 응답의 permissions 는 권한 타입별(admin/user)로 그룹화되고, 각 그룹은 label·icon 메타와 필터링된 권한 트리를 담는다. 함께 반환되는 types(권한 타입 목록), default_type(기본 탭), scope_options(scope_type 선택지: 전체/역할/본인)는 편집 UI 구성에 쓰인다. 리프 노드만 실제 부여 가능한 권한(is_assignable)이다. core.permissions.read 권한이 필요하다.