Files

T

HeuJung 6c8381f164 fix(core,board,ecommerce,plugins): API 문서 미채움 마커 전수 채움 + 미해석 lang 키 정정 + IDV 조회 시도횟수 비노출

이슈 본연: API 레퍼런스의 미채움 마커 5종(실측 제외/TODO/필드 없음/대표 에러 없음)
1,194건을 코드에서 읽어 전수 채우고(0건), api:docgen 재생성이 사람이 채운 내용을
손실·열화시키던 멱등성 결함 4종(CRLF, 표 파이프 이스케이프, 에러 서술 보존, 중복
라우트명 키)을 근본 수정. --check 를 실측 제외와 드리프트가 구분되도록 재정의.
ParameterDescriber/ResourceFieldDescriber 에 leaf 폴백·SEO 스코프·공통 사전 확장.

파생 결함(문서 실측 중 발견): ResponseHelper 기본 메시지 키 6종이 존재하지 않는
messages.* 를 가리켜 응답 message 가 번역문 대신 키 문자열로 노출되던 문제를 common.*
으로 정정하고, 코어 7 + gdpr/marketing/pay_kginicis/verification/ecommerce 확장의
호출부와 누락 lang 키(게시판 10키 + 이커머스 category_images 4키 포함)를 ko/en/ja
전수 정정. 중복 그룹 키 2건은 기존 키로 호출부 통합.

보안: GET /api/identity/challenges/{id} 는 권한 가드 없는 공개 폴링 엔드포인트인데
Service::getStatus 가 attempts/max_attempts 를 응답에 담아 남은 시도 횟수를 추론할 수
있었다. 두 필드를 제거하고, 챌린지 화면(admin_basic/basic)의 서버 attempts 참조를
제거(남은 횟수 UI 는 query fallback + verify 실패 시 로컬 증가로 유지).

부수 정리(변경셋에 들어온 board 컨트롤러의 audit 사전 결함): FormRequest 4개 신설로
base Request 주입 제거, CommentController 의 Board 직접 호출을 BoardService 위임으로
전환, PHPDoc @return 보강. board 스위트에서 발견한 stale test 3건(seed SSoT 불일치,
admin 계정 user 역할 누락)도 같은 세션에서 정정.

버전 정렬(공개 release 기준): 코어 7.0.3→7.0.4, sirsoft-board 1.0.1→1.0.2,
verification_kginicis 1.0.0→1.0.1, admin_basic 1.0.1→1.0.4.

2026-08-06 14:16:40 +09:00

6.1 KiB

Raw Permalink Blame History

Users API 레퍼런스

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

TL;DR (5초 요약)

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

PATCH /api/modules/sirsoft-ecommerce/admin/users/{user}/currency

라우트명: api.modules.sirsoft-ecommerce.admin.users.currency.update
컨트롤러: Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\AdminUserCurrencyController@update
인증/권한: auth:sanctum + permission:sirsoft-ecommerce.user-currency.manage

요청 파라미터

이름	위치	타입	필수	허용값	용도
user	path	string	예	—	대상 user의 식별자
currency	body	string	예	—	회원에게 지정할 결제 통화 코드 (등록 통화: is_default 또는 exchange_rate>0 인 통화만 허용)

요청 예시

PATCH /api/modules/sirsoft-ecommerce/admin/users/{user}/currency HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}
Content-Type: application/json

{
    "currency": "예시값"
}

응답 필드 (data 내부)

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

필드	타입	실측 예시값	용도/설명
preferred_currency	string	`KRW`	변경 후 저장된 회원 선호 결제 통화 코드 (ISO 4217, 등록 통화 중 하나)

응답 예시

HTTP/1.1 200

{
    "success": true,
    "message": "결제 통화가 변경되었습니다.",
    "data": {
        "preferred_currency": "KRW"
    }
}

에러 응답

상태코드	의미	발생 조건
401	Unauthenticated	유효한 Bearer 토큰이 없거나 만료된 경우
403	Forbidden	요구 권한(`sirsoft-ecommerce.user-currency.manage`)이 없는 경우
404	Not Found	path 파라미터에 해당하는 리소스가 없는 경우
422	Unprocessable Entity	요청 파라미터가 검증 규칙을 위반한 경우 (`error.errors` 에 필드별 메시지). `currency` 미전달 또는 등록 통화(is_default \| exchange_rate>0)가 아닌 코드 전달 시
500	Internal Server Error	통화 저장 처리 중 예외 발생 시 (`결제 통화 변경에 실패했습니다.`)

설명 관리자가 특정 회원의 선호 결제 통화를 변경합니다. auth:sanctum + admin + sirsoft-ecommerce.user-currency.manage 권한이 필요하며, path의 {user}는 UUID 라우트 모델 바인딩(관리자 회원 URL 규약)으로 주입됩니다. UserCurrencyService::changeUserCurrencyByAdmin()이 통화 저장과 활동 로그 훅 발화를 한 단위로 처리하며, currency는 등록된 통화 코드만 허용됩니다. 관리자 회원 상세 화면에서 회원별 결제 통화를 지정하는 용도입니다.

PATCH /api/modules/sirsoft-ecommerce/admin/users/{user}/shipping-country

라우트명: api.modules.sirsoft-ecommerce.admin.users.shipping-country.update
컨트롤러: Modules\Sirsoft\Ecommerce\Http\Controllers\Admin\AdminUserShippingCountryController@update
인증/권한: auth:sanctum + permission:sirsoft-ecommerce.user-shipping-country.manage