ソースを参照

style(controller): 优化PolicyFeeController接口参数注解和文档说明

- 引入Swagger注解Parameter,完善接口参数描述
- 更新getPolicyFee方法中站点信息、销售类型和渠道方ID的注释信息
- 明确销售类型为1和2时渠道方ID为必填项
- 增强接口文档的准确性和可读性
SheepHy 21 時間 前
コミット
dee6c154fa

+ 7 - 3
src/main/java/com/zsElectric/boot/business/controller/PolicyFeeController.java

@@ -12,6 +12,7 @@ import com.zsElectric.boot.business.service.ThirdPartyInfoService;
 import com.zsElectric.boot.core.web.PageResult;
 import com.zsElectric.boot.core.web.Result;
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.*;
@@ -69,16 +70,19 @@ public class PolicyFeeController {
     /**
      * 查询策略费用
      *
-     * @param stationId 站点ID
-     * @param salesType 销售类型
-     * @param thirdPartyId 渠道方ID
+     * @param stationId 站点信息ID(关联third_party_station_info表)
+     * @param salesType 销售类型(0-平台 1-企业 2-渠道方)
+     * @param thirdPartyId 渠道方ID(销售类型为1、2时必填)关联c_third_party_info
      * @return 策略费用列表
      */
     @Operation(summary = "查询策略费用")
     @GetMapping("/getPolicyFee")
     public Result<List<TimePeriodPriceVO>> getPolicyFee(
+            @Parameter(description = "站点信息ID(关联third_party_station_info表)", required = true)
             @RequestParam Long stationId,
+            @Parameter(description = "销售类型(0-平台 1-企业 2-渠道方)", required = true)
             @RequestParam Integer salesType,
+            @Parameter(description = "渠道方ID(销售类型为1、2时必填)关联c_third_party_info")
             @RequestParam(required = false, defaultValue = "0") Integer thirdPartyId) {
         return Result.success(policyFeeService.getPolicyFee(stationId, salesType, thirdPartyId));
     }