diff --git a/openhis-server/openhis-application/src/main/java/com/openhis/web/swaggerexample/controller/SwaggerExampleController.java b/openhis-server/openhis-application/src/main/java/com/openhis/web/swaggerexample/controller/SwaggerExampleController.java new file mode 100644 index 00000000..b6519623 --- /dev/null +++ b/openhis-server/openhis-application/src/main/java/com/openhis/web/swaggerexample/controller/SwaggerExampleController.java @@ -0,0 +1,58 @@ +package com.openhis.web.swaggerexample.controller; + +import java.util.Collections; +import java.util.List; + +import org.springframework.web.bind.annotation.*; + +import com.core.common.core.domain.R; +import com.openhis.web.swaggerexample.dto.GetExampleResult; +import com.openhis.web.swaggerexample.dto.PostExampleParam; + +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiOperation; +import io.swagger.annotations.ApiParam; +import lombok.AllArgsConstructor; +import lombok.extern.slf4j.Slf4j; + +/** + * swagger例子Controller + * + * @author guorui + * @date 2025/3/17 + */ +@RestController +@Slf4j +@AllArgsConstructor +@Api(tags = "swagger例子") +@RequestMapping("/swagger-example") +public class SwaggerExampleController { + // TODO:这只是个例子,后期请删除 + + /** + * get接口示例 + * + * @param param1 路径参数 + * @param param2 一般参数 + * @return 结果 + */ + @ApiOperation(value = "get接口示例") + @GetMapping("/get/{param1}") + public R> getExample(@PathVariable @ApiParam(name = "param1", value = "路径参数") String param1, + @RequestParam @ApiParam(name = "param2", value = "一般参数") String param2) { + return R.ok(Collections.emptyList(), "查询成功!"); + } + + /** + * post接口示例 + * + * @param postExampleParam POST请求参数类 + * @return 结果 + */ + @ApiOperation(value = "post接口示例") + @PostMapping("/post") + public R postExample(@RequestBody PostExampleParam postExampleParam) { + return R.ok("处理成功!"); + } + +} diff --git a/openhis-server/openhis-application/src/main/java/com/openhis/web/swaggerexample/dto/GetExampleResult.java b/openhis-server/openhis-application/src/main/java/com/openhis/web/swaggerexample/dto/GetExampleResult.java new file mode 100644 index 00000000..90a2cd2d --- /dev/null +++ b/openhis-server/openhis-application/src/main/java/com/openhis/web/swaggerexample/dto/GetExampleResult.java @@ -0,0 +1,38 @@ +package com.openhis.web.swaggerexample.dto; + +import java.math.BigDecimal; + +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import lombok.Data; + +/** + * GET请求结果类 + */ +@Data +@ApiModel(value = "GET请求结果类") +public class GetExampleResult { + // TODO:这只是个例子,后期请删除 + + /** + * ID + */ + @ApiModelProperty(value = "ID") + private Long id; + /** + * 名称 + */ + @ApiModelProperty(value = "名称") + private String name; + /** + * 编码 + */ + @ApiModelProperty(value = "编码") + private Integer code; + /** + * 总额 + */ + @ApiModelProperty(value = "总额") + private BigDecimal amount; + +} diff --git a/openhis-server/openhis-application/src/main/java/com/openhis/web/swaggerexample/dto/PostExampleParam.java b/openhis-server/openhis-application/src/main/java/com/openhis/web/swaggerexample/dto/PostExampleParam.java new file mode 100644 index 00000000..9de5dd1a --- /dev/null +++ b/openhis-server/openhis-application/src/main/java/com/openhis/web/swaggerexample/dto/PostExampleParam.java @@ -0,0 +1,37 @@ +package com.openhis.web.swaggerexample.dto; + +import java.math.BigDecimal; + +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import lombok.Data; + +/** + * POST请求参数类 + */ +@Data +@ApiModel(value = "POST请求参数类") +public class PostExampleParam { + // TODO:这只是个例子,后期请删除 + + /** + * ID + */ + @ApiModelProperty(value = "ID") + private Long id; + /** + * 名称 + */ + @ApiModelProperty(value = "名称") + private String name; + /** + * 编码 + */ + @ApiModelProperty(value = "编码") + private Integer code; + /** + * 总额 + */ + @ApiModelProperty(value = "总额") + private BigDecimal amount; +}