Files
Gnuboard7/docs/backend/api/extensions.md
T
HeuJung b5c0ec1178 fix(core,ecommerce,board,page,admin_basic,basic): 목록 응답의 하위 컬렉션 전량 직렬화 해소
관리자 상품목록을 한 페이지 여는 것만으로 그 페이지 모든 상품의 옵션이 응답에 실렸다.
같은 패턴을 저장소 전역에서 찾아 14개 목록 엔드포인트를 함께 정리했다.

근본 원인은 둘이다. Resource 가 whenLoaded 로 방어하는데 Repository 가 목록 쿼리에서
관계를 무조건 로드해 가드가 항상 참이 되는 가짜 가드, 그리고 toListArray 경량 표현을
정의해 두고도 컬렉션이 toArray 를 부르는 목록/상세 미분리다. 둘 다 응답만 보면
정상이라 오류도 경고도 없이 페이로드만 불어난다.

목록은 화면이 실제로 그리는 것만 싣는다. 개수·합계는 PHP 컬렉션 연산이 아니라 DB
집계로, 대표 1건이 필요한 곳은 관계 자체를 oldestOfMany 로 좁힌다. eager load 의
limit(1) 은 부모별이 아니라 배치 쿼리 전체에 걸려 첫 행만 값을 갖게 되므로 쓸 수 없다.

뺀 값에는 대체 경로를 먼저 만들었다. 상품 옵션은 행을 펼칠 때 배치로 불러오고(상품 수와
무관하게 쿼리 상수), 종전 동작이 필요한 호출자를 위해 ?with_options=1 등 opt-in 을 남겼다.
배송정책 국가설정과 리뷰 첨부 이미지는 소비처를 실측한 결과 화면이 실제로 그리고 있어
제거하지 않았다 — 그 소비 사실을 회귀 테스트로 고정했다.

재발 방지로 정적 검사 룰 4종과 규정 문서 항목을 함께 넣었다.
2026-08-05 21:20:05 +09:00

6.9 KiB

Extensions API 레퍼런스

소유: 코어 · 생성: php artisan api:docgen (실측 기반). @generated 블록은 재생성 시 갱신되며, 사람이 작성한 설명은 보존됩니다.


TL;DR (5초 요약)

1. 이 문서는 실제 API 호출로 실측한 Extensions 엔드포인트 레퍼런스입니다
2. 각 엔드포인트: 메서드/URI/권한 + 요청 파라미터 표 + 요청 예시(curl) + 실측 응답 필드 표 + 응답 예시(envelope)
3. 응답 필드의 예시값·응답 예시 JSON 은 실제 호출 응답에서 관측된 값입니다
4. 갱신: 코드 변경 후 php artisan api:docgen 재실행
5. 설명(TODO) 칸은 사람이 채웁니다

GET /api/admin/extensions/auto-deactivated

  • 라우트명: api.admin.extensions.auto-deactivated
  • 컨트롤러: App\Http\Controllers\Api\Admin\ExtensionRecoveryController@autoDeactivated
  • 인증/권한: auth:sanctum + permission:core.plugins.activate

요청 파라미터

요청 파라미터 없음.

요청 예시

GET /api/admin/extensions/auto-deactivated HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}

응답 필드 (data 내부)

단건 응답: data 객체의 필드.

필드 타입 실측 예시값 용도/설명
items object {"plugins":[],"modules":[],"templates":[]} 코어 비호환으로 자동 비활성화된 확장을 타입별(plugins/modules/templates)로 묶은 목록. 각 원소는 식별자(identifier), 비호환 요구 버전(incompatible_required_version), 비활성화 시각(deactivated_at)을 가지며, 사용자가 dismiss했거나 hidden(학습용 샘플) 확장은 제외됨
current_core_version string 7.0.6 현재 설치된 코어 버전

응답 예시

HTTP/1.1 200
{
    "success": true,
    "message": "자동 비활성화된 확장 목록입니다.",
    "data": {
        "items": {
            "plugins": [],
            "modules": [],
            "templates": []
        },
        "current_core_version": "7.0.6"
    }
}

에러 응답

상태코드 의미 발생 조건
401 Unauthenticated 유효한 Bearer 토큰이 없거나 만료된 경우
403 Forbidden 요구 권한(core.plugins.activate)이 없는 경우

설명 코어 버전 비호환으로 자동 비활성화된 확장 목록을 타입별(plugins/modules/templates)로 반환합니다. 각 항목에는 식별자, 비호환 요구 버전, 비활성화 시각과 함께 현재 코어 버전이 담깁니다. 사용자가 dismiss한 알림과 hidden(학습용 샘플) 확장은 결과에서 제외됩니다. core.plugins.activate 권한이 필요하며, 상단 배너·대시보드 카드의 데이터 소스로 사용됩니다.

POST /api/admin/extensions/{type}/{identifier}/dismiss

  • 라우트명: api.admin.extensions.dismiss
  • 컨트롤러: App\Http\Controllers\Api\Admin\ExtensionRecoveryController@dismiss
  • 인증/권한: auth:sanctum + permission:core.plugins.activate

요청 파라미터

이름 위치 타입 필수 허용값 용도
type path string 예 — 대상 확장의 타입 (module: 모듈, plugin: 플러그인, template: 템플릿). 타입에 맞는 Repository/Manager를 해석하는 데 사용되며 그 외 값은 422
identifier path string 예 — 대상 리소스의 식별자

요청 예시

POST /api/admin/extensions/{type}/{identifier}/dismiss HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}

응답 필드 (data 내부)

응답 예시

에러 응답

상태코드 의미 발생 조건
401 Unauthenticated 유효한 Bearer 토큰이 없거나 만료된 경우
403 Forbidden 요구 권한(core.plugins.activate)이 없는 경우
404 Not Found path 파라미터에 해당하는 리소스가 없는 경우

설명 특정 확장의 호환성 알림을 현재 사용자 기준으로 dismiss(닫기) 처리합니다. 경로의 {type}(module|plugin|template)과 {identifier}로 대상을 지정하며, 해당 확장의 자동 비활성화 알림과 재호환 알림을 함께 dismiss합니다. core.plugins.activate 권한이 필요합니다. dismiss는 사용자별로 저장되므로, 캐시 만료나 감지 갱신 시 재호환 상태가 바뀌면 다시 노출될 수 있습니다.

POST /api/admin/extensions/{type}/{identifier}/recover

  • 라우트명: api.admin.extensions.recover
  • 컨트롤러: App\Http\Controllers\Api\Admin\ExtensionRecoveryController@recover
  • 인증/권한: auth:sanctum + permission:core.plugins.activate

요청 파라미터

이름 위치 타입 필수 허용값 용도
type path string 예 — 대상 확장의 타입 (module: 모듈, plugin: 플러그인, template: 템플릿). 타입에 맞는 Repository/Manager를 해석하는 데 사용되며 그 외 값은 422
identifier path string 예 — 대상 리소스의 식별자

요청 예시

POST /api/admin/extensions/{type}/{identifier}/recover HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}

응답 필드 (data 내부)

응답 예시

에러 응답

상태코드 의미 발생 조건
401 Unauthenticated 유효한 Bearer 토큰이 없거나 만료된 경우
403 Forbidden 요구 권한(core.plugins.activate)이 없는 경우
404 Not Found path 파라미터에 해당하는 리소스가 없는 경우

설명 코어와 재호환된 확장을 원클릭으로 복구(재활성화)합니다. 경로의 {type}/{identifier}로 대상을 지정하며, 대상이 IncompatibleCore 사유로 자동 비활성화된 상태인지 검증한 뒤 코어 버전 재검증을 거쳐 활성화합니다. 잘못된 타입은 422, 미존재 확장은 404, hidden 확장이나 자동 비활성화가 아닌 경우는 error_code와 함께 422를 반환하고, 재검증 실패 시 글로벌 핸들러가 core_version_mismatch로 변환합니다. core.plugins.activate 권한이 필요합니다.