refactor: Controller에서 Swagger 어노테이션 분리

- EstimateController에서 Swagger 어노테이션 제거 → EstimateApi.php 생성
- CommonController에서 Swagger 어노테이션 제거 → CommonApi.php 업데이트
- TenantFieldSettingController에서 Swagger 어노테이션 제거 → TenantFieldSettingApi.php 생성
- Swagger 정책 준수: Controller는 비즈니스 로직만, Swagger는 별도 파일로 분리

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
2025-12-21 03:56:48 +09:00
parent a79238558d
commit 1449683aae
6 changed files with 530 additions and 543 deletions

View File

@@ -6,49 +6,8 @@
use Illuminate\Http\Request;
use Illuminate\Support\Facades\DB;
/**
* @OA\Tag(
* name="Settings - Common Codes",
* description="공통 코드 관리 API"
* )
*/
class CommonController
{
/**
* @OA\Get(
* path="/api/v1/settings/common/code",
* summary="공통 코드 조회",
* description="테넌트의 활성화된 공통 코드 목록을 조회합니다.",
* tags={"Settings - Common Codes"},
* security={{"ApiKeyAuth": {}}},
*
* @OA\Response(
* response=200,
* description="공통 코드 조회 성공",
*
* @OA\JsonContent(
* type="object",
*
* @OA\Property(property="success", type="boolean", example=true),
* @OA\Property(property="message", type="string", example="공통코드"),
* @OA\Property(
* property="data",
* type="array",
*
* @OA\Items(
* type="object",
*
* @OA\Property(property="code_group", type="string", example="product_type"),
* @OA\Property(property="code", type="string", example="PRODUCT"),
* @OA\Property(property="name", type="string", example="제품"),
* @OA\Property(property="description", type="string", example="완제품"),
* @OA\Property(property="is_active", type="boolean", example=true)
* )
* )
* )
* )
* )
*/
public static function getComeCode()
{
return ApiResponse::handle(function () {
@@ -59,20 +18,6 @@ public static function getComeCode()
}, '공통코드');
}
/**
* @OA\Get(
* path="/api/v1/settings/common",
* summary="공통 코드 목록 조회",
* description="전체 공통 코드 목록을 조회합니다.",
* tags={"Settings - Common Codes"},
* security={{"ApiKeyAuth": {}, "BearerAuth": {}}},
*
* @OA\Response(
* response=200,
* description="공통 코드 목록 조회 성공"
* )
* )
*/
public function list(Request $request)
{
return ApiResponse::handle(function () {
@@ -81,29 +26,6 @@ public function list(Request $request)
}, __('message.fetched'));
}
/**
* @OA\Get(
* path="/api/v1/settings/common/{group}",
* summary="특정 그룹 공통 코드 조회",
* description="특정 그룹의 공통 코드 목록을 조회합니다.",
* tags={"Settings - Common Codes"},
* security={{"ApiKeyAuth": {}, "BearerAuth": {}}},
*
* @OA\Parameter(
* name="group",
* in="path",
* required=true,
* description="코드 그룹",
*
* @OA\Schema(type="string", example="product_type")
* ),
*
* @OA\Response(
* response=200,
* description="그룹 코드 조회 성공"
* )
* )
*/
public function index(Request $request, string $group)
{
return ApiResponse::handle(function () {
@@ -112,51 +34,6 @@ public function index(Request $request, string $group)
}, __('message.fetched'));
}
/**
* @OA\Post(
* path="/api/v1/settings/common",
* summary="공통 코드 생성",
* description="새로운 공통 코드를 생성합니다.",
* tags={"Settings - Common Codes"},
* security={{"ApiKeyAuth": {}, "BearerAuth": {}}},
*
* @OA\RequestBody(
* required=true,
*
* @OA\JsonContent(
* type="object",
*
* @OA\Property(property="code_group", type="string", example="product_type"),
* @OA\Property(property="code", type="string", example="SERVICE"),
* @OA\Property(property="name", type="string", example="서비스"),
* @OA\Property(property="description", type="string", example="서비스 상품")
* )
* ),
*
* @OA\Response(
* response=201,
* description="공통 코드 생성 성공"
* ),
* @OA\Response(
* response=409,
* description="중복된 공통 코드",
*
* @OA\JsonContent(
* type="object",
*
* @OA\Property(property="success", type="boolean", example=false),
* @OA\Property(property="message", type="string", example="중복된 공통 코드가 존재합니다.")
* )
* ),
*
* @OA\Response(
* response=422,
* description="유효성 검사 실패",
*
* @OA\JsonContent(ref="#/components/schemas/ErrorResponse")
* )
* )
*/
public function store(Request $request)
{
return ApiResponse::handle(function () {
@@ -165,58 +42,6 @@ public function store(Request $request)
}, __('message.settings.common_code_saved'));
}
/**
* @OA\Patch(
* path="/api/v1/settings/common/{id}",
* summary="공통 코드 수정",
* description="기존 공통 코드를 수정합니다.",
* tags={"Settings - Common Codes"},
* security={{"ApiKeyAuth": {}, "BearerAuth": {}}},
*
* @OA\Parameter(
* name="id",
* in="path",
* required=true,
* description="공통 코드 ID",
*
* @OA\Schema(type="integer", example=1)
* ),
*
* @OA\RequestBody(
* required=true,
*
* @OA\JsonContent(
* type="object",
*
* @OA\Property(property="name", type="string", example="수정된 이름"),
* @OA\Property(property="description", type="string", example="수정된 설명")
* )
* ),
*
* @OA\Response(
* response=200,
* description="공통 코드 수정 성공"
* ),
* @OA\Response(
* response=404,
* description="공통 코드를 찾을 수 없음",
*
* @OA\JsonContent(
* type="object",
*
* @OA\Property(property="success", type="boolean", example=false),
* @OA\Property(property="message", type="string", example="해당 공통 코드를 찾을 수 없습니다.")
* )
* ),
*
* @OA\Response(
* response=422,
* description="유효성 검사 실패",
*
* @OA\JsonContent(ref="#/components/schemas/ErrorResponse")
* )
* )
*/
public function update(Request $request, int $id)
{
return ApiResponse::handle(function () {
@@ -225,40 +50,6 @@ public function update(Request $request, int $id)
}, __('message.updated'));
}
/**
* @OA\Delete(
* path="/api/v1/settings/common/{id}",
* summary="공통 코드 삭제",
* description="공통 코드를 삭제합니다.",
* tags={"Settings - Common Codes"},
* security={{"ApiKeyAuth": {}, "BearerAuth": {}}},
*
* @OA\Parameter(
* name="id",
* in="path",
* required=true,
* description="공통 코드 ID",
*
* @OA\Schema(type="integer", example=1)
* ),
*
* @OA\Response(
* response=200,
* description="공통 코드 삭제 성공"
* ),
* @OA\Response(
* response=404,
* description="공통 코드를 찾을 수 없음",
*
* @OA\JsonContent(
* type="object",
*
* @OA\Property(property="success", type="boolean", example=false),
* @OA\Property(property="message", type="string", example="해당 공통 코드를 찾을 수 없습니다.")
* )
* )
* )
*/
public function destroy(Request $request, int $id)
{
return ApiResponse::handle(function () {
@@ -266,4 +57,4 @@ public function destroy(Request $request, int $id)
return [];
}, __('message.deleted'));
}
}
}