MeterSphere CommonLib 是一个用于 MeterSphere Plugin 的公共库,专注于提供通用的功能和工具。
- 基于 Javadoc 的分析,无需额外的注解
- 自动识别类,生成接口定义到 MeterSphere
- 支持列表、集合和其他数据结构,包括嵌套泛型解析
@Controller
:标记类为控制器,处理 HTTP 请求。@RestController
:结合@Controller
和@ResponseBody
,用于 RESTful 服务,返回 JSON 或 XML 数据。@RequestMapping
:将 HTTP 请求映射到 MVC 和 REST 控制器的处理方法,可设置 URL、HTTP 方法等属性。
@GetMapping
:将 HTTP GET 请求映射到特定处理方法。@PutMapping
:将 HTTP PUT 请求映射到特定处理方法。@DeleteMapping
:将 HTTP DELETE 请求映射到特定处理方法。@PatchMapping
:将 HTTP PATCH 请求映射到特定处理方法。@PathVariable
:用于从 URL 中获取参数值,映射到方法的参数上。@RequestBody
:将 HTTP 请求体的内容绑定到方法的参数上,适用于 POST 请求等。@RequestParam
:用于从请求中获取参数值,映射到方法的参数上。@ResponseBody
:将方法的返回值直接作为 HTTP 响应体返回给客户端。
@Api
:修饰整个类,描述类的作用,可设置tags
、value
、description
等属性@ApiOperation
:修饰方法,描述操作或 HTTP 方法,可设置value
、notes
、response
等属性@ApiParam
:修饰方法参数,描述参数,可设置name
、value
、required
、defaultValue
等属性@ApiModel
:修饰 POJO 类,描述类的作用,可设置description
等属性@ApiModelProperty
:修饰类字段,描述字段的作用,可设置value
、notes
、example
等属性
@io.swagger.v3.oas.annotations.Operation
:修饰方法,描述操作或 HTTP 方法,可设置summary
、description
、responses
等属性@io.swagger.v3.oas.annotations.Parameter
:修饰方法参数,描述参数,可设置name
、description
、required
、example
等属性@io.swagger.v3.oas.annotations.media.Schema
:修饰 POJO 类,描述类的作用
javax.validation.constraints.NotNull
javax.validation.constraints.NotEmpty
javax.validation.constraints.NotBlank
javax.validation.constraints.Size
javax.validation.constraints.Min
javax.validation.constraints.Max
javax.validation.constraints.DecimalMin
javax.validation.constraints.DecimalMax
javax.validation.constraints.Positive
javax.validation.constraints.PositiveOrZero
javax.validation.constraints.Negative
javax.validation.constraints.NegativeOrZero
jakarta.validation.constraints.NotNull
jakarta.validation.constraints.NotEmpty
jakarta.validation.constraints.NotBlank
jakarta.validation.constraints.Size
jakarta.validation.constraints.Min
jakarta.validation.constraints.Max
jakarta.validation.constraints.DecimalMin
jakarta.validation.constraints.DecimalMax
jakarta.validation.constraints.Positive
jakarta.validation.constraints.PositiveOrZero
jakarta.validation.constraints.Negative
jakarta.validation.constraints.NegativeOrZero
-
API 相关:
- 文档注释标记
@module
>@menu
>@Api
> Doc 注释第一行 - API Summary Swagger 2
@ApiOperation
> OpenAPI 3@Operation
> 文档注释标记@Description
> 文档注释第一行
- 文档注释标记
-
参数相关逻辑同 API 相关优先级一致。