feat: BOM 계산 API Swagger 문서 완성 및 오류 수정
- BomCalculationApi.php: 기존 시스템 방식 클래스 형태 Swagger 문서 작성 - BOM Calculation 태그로 5개 API 엔드포인트 완전 문서화 - 요청/응답 스키마, 예시 데이터, 오류 응답 모두 정의 - BomCalculationController.php: ApiResponse 클래스 참조 경로 수정 - App\Http\Resources\ApiResponse → App\Helpers\ApiResponse - 테스트 데이터 생성으로 완전한 API 테스트 환경 구축 Swagger UI에서 "BOM Calculation" 메뉴로 확인 가능 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -7,15 +7,10 @@
|
||||
use App\Http\Requests\Design\GetEstimateParametersRequest;
|
||||
use App\Http\Requests\Design\CalculateBomRequest;
|
||||
use App\Http\Requests\Design\SaveCompanyFormulaRequest;
|
||||
use App\Http\Resources\ApiResponse;
|
||||
use App\Helpers\ApiResponse;
|
||||
use Illuminate\Http\Request;
|
||||
use Illuminate\Http\JsonResponse;
|
||||
|
||||
/**
|
||||
* @group Design/BOM Calculation
|
||||
*
|
||||
* BOM 기반 동적 산출식 계산 API
|
||||
*/
|
||||
class BomCalculationController extends Controller
|
||||
{
|
||||
protected BomCalculationService $bomCalculationService;
|
||||
@@ -25,45 +20,6 @@ public function __construct(BomCalculationService $bomCalculationService)
|
||||
$this->bomCalculationService = $bomCalculationService;
|
||||
}
|
||||
|
||||
/**
|
||||
* 견적 파라미터 조회
|
||||
*
|
||||
* 특정 모델의 견적 시 필요한 입력 파라미터 스키마를 조회합니다.
|
||||
* BOM에 정의된 조건만 동적으로 추출하여 반환합니다.
|
||||
*
|
||||
* @urlParam model_id int required 모델 ID Example: 1
|
||||
* @queryParam company_name string 업체명 (선택사항) Example: 경동기업
|
||||
*
|
||||
* @response 200 {
|
||||
* "success": true,
|
||||
* "message": "견적 파라미터를 성공적으로 조회했습니다.",
|
||||
* "data": {
|
||||
* "model_info": {
|
||||
* "id": 1,
|
||||
* "name": "스크린셔터 표준형",
|
||||
* "version": "v1.0",
|
||||
* "bom_template_id": 1
|
||||
* },
|
||||
* "company_info": {
|
||||
* "company_type": "경동기업",
|
||||
* "formula_version": "v2.0",
|
||||
* "requested_company": "경동기업"
|
||||
* },
|
||||
* "parameters": {
|
||||
* "required_parameters": [
|
||||
* {
|
||||
* "key": "W0",
|
||||
* "label": "오픈사이즈 가로(mm)",
|
||||
* "type": "integer",
|
||||
* "required": true,
|
||||
* "min": 500,
|
||||
* "max": 15000
|
||||
* }
|
||||
* ]
|
||||
* }
|
||||
* }
|
||||
* }
|
||||
*/
|
||||
public function getEstimateParameters(GetEstimateParametersRequest $request, int $modelId): JsonResponse
|
||||
{
|
||||
return ApiResponse::handle(function () use ($request, $modelId) {
|
||||
@@ -79,55 +35,6 @@ public function getEstimateParameters(GetEstimateParametersRequest $request, int
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* BOM 계산 실행
|
||||
*
|
||||
* 입력된 파라미터를 기반으로 BOM 수량을 동적으로 계산합니다.
|
||||
* 업체별 산출식을 적용하여 실시간 견적을 생성합니다.
|
||||
*
|
||||
* @urlParam bom_template_id int required BOM 템플릿 ID Example: 1
|
||||
*
|
||||
* @bodyParam parameters object required 계산 파라미터
|
||||
* @bodyParam parameters.W0 int required 오픈사이즈 가로(mm) Example: 3000
|
||||
* @bodyParam parameters.H0 int required 오픈사이즈 세로(mm) Example: 2500
|
||||
* @bodyParam parameters.product_type string required 제품타입 Example: screen
|
||||
* @bodyParam company_name string 업체명 (선택사항) Example: 경동기업
|
||||
*
|
||||
* @response 200 {
|
||||
* "success": true,
|
||||
* "message": "BOM 계산이 완료되었습니다.",
|
||||
* "data": {
|
||||
* "bom_template": {
|
||||
* "id": 1,
|
||||
* "name": "Main",
|
||||
* "company_type": "경동기업",
|
||||
* "formula_version": "v2.0"
|
||||
* },
|
||||
* "input_parameters": {
|
||||
* "W0": 3000,
|
||||
* "H0": 2500,
|
||||
* "product_type": "screen"
|
||||
* },
|
||||
* "calculated_values": {
|
||||
* "W1": 3160,
|
||||
* "H1": 2850,
|
||||
* "area": 9.006,
|
||||
* "weight": 60.42
|
||||
* },
|
||||
* "bom_items": [
|
||||
* {
|
||||
* "item_id": 1,
|
||||
* "ref_type": "MATERIAL",
|
||||
* "ref_id": 101,
|
||||
* "original_qty": 1,
|
||||
* "calculated_qty": 2,
|
||||
* "is_calculated": true,
|
||||
* "calculation_formula": "bracket_quantity"
|
||||
* }
|
||||
* ]
|
||||
* }
|
||||
* }
|
||||
*/
|
||||
public function calculateBom(CalculateBomRequest $request, int $bomTemplateId): JsonResponse
|
||||
{
|
||||
return ApiResponse::handle(function () use ($request, $bomTemplateId) {
|
||||
@@ -155,30 +62,6 @@ public function calculateBom(CalculateBomRequest $request, int $bomTemplateId):
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* 업체별 산출식 목록 조회
|
||||
*
|
||||
* 특정 업체의 등록된 산출식 목록을 조회합니다.
|
||||
*
|
||||
* @urlParam company_name string required 업체명 Example: 경동기업
|
||||
*
|
||||
* @response 200 {
|
||||
* "success": true,
|
||||
* "message": "업체 산출식 목록을 조회했습니다.",
|
||||
* "data": {
|
||||
* "company_name": "경동기업",
|
||||
* "total_formulas": 5,
|
||||
* "formulas": [
|
||||
* {
|
||||
* "type": "manufacturing_size",
|
||||
* "version": "v2.0",
|
||||
* "description": "제작사이즈 계산식",
|
||||
* "updated_at": "2025-09-22T15:30:00Z"
|
||||
* }
|
||||
* ]
|
||||
* }
|
||||
* }
|
||||
*/
|
||||
public function getCompanyFormulas(string $companyName): JsonResponse
|
||||
{
|
||||
return ApiResponse::handle(function () use ($companyName) {
|
||||
@@ -192,34 +75,6 @@ public function getCompanyFormulas(string $companyName): JsonResponse
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* 업체별 산출식 등록/수정
|
||||
*
|
||||
* 특정 업체의 산출식을 등록하거나 수정합니다.
|
||||
* 기존 산출식이 있으면 새 버전으로 업데이트됩니다.
|
||||
*
|
||||
* @urlParam company_name string required 업체명 Example: 경동기업
|
||||
* @urlParam formula_type string required 산출식 타입 Example: manufacturing_size
|
||||
*
|
||||
* @bodyParam formula_expression string required 계산식 표현식
|
||||
* @bodyParam parameters array required 필요한 파라미터 정의
|
||||
* @bodyParam conditions array 적용 조건 (선택사항)
|
||||
* @bodyParam validation_rules array 검증 규칙 (선택사항)
|
||||
* @bodyParam description string 산출식 설명 (선택사항)
|
||||
*
|
||||
* @response 201 {
|
||||
* "success": true,
|
||||
* "message": "업체 산출식이 등록되었습니다.",
|
||||
* "data": {
|
||||
* "id": 1,
|
||||
* "company_name": "경동기업",
|
||||
* "formula_type": "manufacturing_size",
|
||||
* "version": "v1.0",
|
||||
* "is_active": true,
|
||||
* "created_at": "2025-09-22T15:30:00Z"
|
||||
* }
|
||||
* }
|
||||
*/
|
||||
public function saveCompanyFormula(SaveCompanyFormulaRequest $request, string $companyName, string $formulaType): JsonResponse
|
||||
{
|
||||
return ApiResponse::handle(function () use ($request, $companyName, $formulaType) {
|
||||
@@ -235,25 +90,6 @@ public function saveCompanyFormula(SaveCompanyFormulaRequest $request, string $c
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* 계산식 테스트 실행
|
||||
*
|
||||
* 산출식을 실제 적용하기 전에 테스트해볼 수 있습니다.
|
||||
*
|
||||
* @bodyParam formula_expression string required 테스트할 계산식
|
||||
* @bodyParam test_parameters object required 테스트 파라미터
|
||||
*
|
||||
* @response 200 {
|
||||
* "success": true,
|
||||
* "message": "계산식 테스트가 완료되었습니다.",
|
||||
* "data": {
|
||||
* "formula_expression": "bracket_quantity",
|
||||
* "input_parameters": {"W1": 3000},
|
||||
* "result": {"result": 2},
|
||||
* "execution_time_ms": 1.5
|
||||
* }
|
||||
* }
|
||||
*/
|
||||
public function testFormula(Request $request): JsonResponse
|
||||
{
|
||||
return ApiResponse::handle(function () use ($request) {
|
||||
|
||||
Reference in New Issue
Block a user