swagger 为自定义验证注释自动生成模式答案

【问题标题】：swagger autogenerate schema for a custom validation annotationswagger 为自定义验证注释自动生成模式
【发布时间】：2021-04-30 18:37:36
【问题描述】：

我创建了一个类似于@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 openapi micronaut

【解决方案1】：

我需要为我的控制器方法的参数生成 swagger.yml。

只需使用pattern 属性添加@io.swagger.v3.oas.annotations.media.Schema 注释即可。或者如果它是一个列表，那么你可以使用@io.swagger.v3.oas.annotations.media.ArraySchema(schema = @Schema(pattern = ?))

这样就可以了。

【讨论】：