用于自定义验证注释的 swagger 自动生成模式
swagger autogenerate schema for a custom validation annotation
我创建了一个类似于 @javax.validation.constraints.Pattern
的自定义验证注释。对于 @Pattern
,swagger 生成了一个很好的模式,如下所示:
summary: my summary
operationId: my_operation_id
parameters:
- name: myParam
in: header
required: true
schema:
maxLength: 30
pattern: ^\w+$ <--- THIS ONE
type: string
但对于我的注释 @CustomPattern
(比方说),它不是!生成的 swagger.yml 在 schema
下没有 pattern
键。我怎样才能创建一个?
这是在 Micronaut 中。
我需要为我的控制器方法的参数生成 swagger.yml。
只需添加一个带有 pattern
属性的 @io.swagger.v3.oas.annotations.media.Schema
注释即可。或者,如果它是一个列表,那么您可以使用 @io.swagger.v3.oas.annotations.media.ArraySchema(schema = @Schema(pattern = ?))
那就行了。