HeuJung
b5c0ec1178
관리자 상품목록을 한 페이지 여는 것만으로 그 페이지 모든 상품의 옵션이 응답에 실렸다. 같은 패턴을 저장소 전역에서 찾아 14개 목록 엔드포인트를 함께 정리했다. 근본 원인은 둘이다. Resource 가 whenLoaded 로 방어하는데 Repository 가 목록 쿼리에서 관계를 무조건 로드해 가드가 항상 참이 되는 가짜 가드, 그리고 toListArray 경량 표현을 정의해 두고도 컬렉션이 toArray 를 부르는 목록/상세 미분리다. 둘 다 응답만 보면 정상이라 오류도 경고도 없이 페이로드만 불어난다. 목록은 화면이 실제로 그리는 것만 싣는다. 개수·합계는 PHP 컬렉션 연산이 아니라 DB 집계로, 대표 1건이 필요한 곳은 관계 자체를 oldestOfMany 로 좁힌다. eager load 의 limit(1) 은 부모별이 아니라 배치 쿼리 전체에 걸려 첫 행만 값을 갖게 되므로 쓸 수 없다. 뺀 값에는 대체 경로를 먼저 만들었다. 상품 옵션은 행을 펼칠 때 배치로 불러오고(상품 수와 무관하게 쿼리 상수), 종전 동작이 필요한 호출자를 위해 ?with_options=1 등 opt-in 을 남겼다. 배송정책 국가설정과 리뷰 첨부 이미지는 소비처를 실측한 결과 화면이 실제로 그리고 있어 제거하지 않았다 — 그 소비 사실을 회귀 테스트로 고정했다. 재발 방지로 정적 검사 룰 4종과 규정 문서 항목을 함께 넣었다.
4.4 KiB
4.4 KiB
Notification Channels API 레퍼런스
소유: 코어 · 생성:
php artisan api:docgen(실측 기반). @generated 블록은 재생성 시 갱신되며, 사람이 작성한 설명은 보존됩니다.
TL;DR (5초 요약)
1. 이 문서는 실제 API 호출로 실측한 Notification Channels 엔드포인트 레퍼런스입니다
2. 각 엔드포인트: 메서드/URI/권한 + 요청 파라미터 표 + 요청 예시(curl) + 실측 응답 필드 표 + 응답 예시(envelope)
3. 응답 필드의 예시값·응답 예시 JSON 은 실제 호출 응답에서 관측된 값입니다
4. 갱신: 코드 변경 후 php artisan api:docgen 재실행
5. 설명(TODO) 칸은 사람이 채웁니다
GET /api/admin/notification-channels
- 라우트명:
api.admin.notification-channels.index - 컨트롤러:
App\Http\Controllers\Api\Admin\NotificationChannelController@index - 인증/권한:
auth:sanctum+permission:core.settings.read
요청 파라미터
요청 파라미터 없음.
요청 예시
GET /api/admin/notification-channels HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}
응답 필드 (data 내부)
단건 응답: data 객체의 필드.
| 필드 | 타입 | 실측 예시값 | 용도/설명 |
|---|---|---|---|
| channels | array | [{"id":"mail","name_key":"notification.channels.mail.name… |
사용 가능한 알림 채널 메타데이터 목록. 각 원소는 id(채널 식별자: mail, database 등), name/name_key·description/description_key(활성 locale 기준 해석된 라벨/설명과 원본 다국어 키), icon(Font Awesome 클래스), source(제공 주체: core/module/plugin)·source_label(출처 표시 라벨), allow_guest(비회원 발송 허용 여부), readiness(컨트롤러가 ChannelReadinessCheckerInterface로 붙인 채널 설정 완료 여부 정보)로 구성됩니다. config 기본 채널(mail, database)에 core.notification.filter_available_channels 훅으로 추가된 확장 채널이 병합됩니다. |
응답 예시
HTTP/1.1 200
{
"success": true,
"message": "알림 채널 목록을 조회했습니다.",
"data": {
"channels": [
{
"id": "mail",
"name_key": "notification.channels.mail.name",
"icon": "fas fa-envelope",
"description_key": "notification.channels.mail.description",
"source": "core",
"source_label_key": "notification.channels.core_default",
"allow_guest": true,
"name": "메일",
"description": "이메일로 알림 발송",
"source_label": "코어 기본 채널",
"readiness": {
"ready": false,
"reason": "notification.readiness.mail_smtp_host_empty"
}
},
{
"id": "database",
"name_key": "notification.channels.database.name",
"icon": "fas fa-bell",
"description_key": "notification.channels.database.description",
"source": "core",
"source_label_key": "notification.channels.core_default",
"allow_guest": false,
"name": "사이트내 알림",
"description": "사이트내 알림 센터에 표시",
"source_label": "코어 기본 채널",
"readiness": {
"ready": true,
"reason": null
}
}
]
}
}
에러 응답
| 상태코드 | 의미 | 발생 조건 |
|---|---|---|
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(core.settings.read)이 없는 경우 |
설명 시스템에서 사용 가능한 알림 채널 목록을 반환하며, 각 채널에 설정 완료 여부(readiness) 정보를 붙여 제공합니다. 인증(auth:sanctum)과 core.settings.read 권한이 필요합니다. 플러그인이 Filter 훅으로 채널을 확장할 수 있으므로 목록은 설치된 확장에 따라 달라집니다. 알림 정의·템플릿 편집 화면에서 채널 선택 옵션을 채우고 미설정 채널을 안내할 때 사용합니다.