如何在OpenAPI的路径变量上添加自定义注解@Encrypted？

针对你遇到的OpenAPI Generator不生成@Encrypted注解的问题，有以下几种解决思路：

1. 使用参数专属的扩展字段 #

x-field-extra-annotation是针对Schema字段的扩展，路径参数属于请求参数范畴，应该使用x-parameter-extra-annotation这个参数级别的扩展。修改你的OpenAPI YAML配置如下：

/notification/{id}/download:
  get:
    parameters:
      - name: id
        schema:
          maxLength: 255
          type: string
        in: path
        required: true
        x-parameter-extra-annotation: "@sbbol.annotation.Encrypted"

注意：这个扩展需要OpenAPI Generator v6.0.0及以上版本支持，确保你使用的是符合要求的版本。

2. 通过Schema引用传递注解 #

如果上述方法不生效，可以将路径参数的Schema抽离到components中，在Schema上添加x-field-extra-annotation，然后让路径参数引用这个Schema：

components:
  schemas:
    EncryptedNotificationId:
      type: string
      maxLength: 255
      x-field-extra-annotation: "@sbbol.annotation.Encrypted"

/notification/{id}/download:
  get:
    parameters:
      - name: id
        schema:
          $ref: '#/components/schemas/EncryptedNotificationId'
        in: path
        required: true

这种方式利用Schema的扩展注解传递到参数上，部分旧版本的Generator也能支持。

3. 自定义控制器模板 #

如果Generator默认模板不支持上述扩展，可以直接修改Spring控制器的模板文件（通常是api.mustache），添加对自定义注解的处理逻辑：
找到模板中处理路径参数注解的位置，插入如下代码片段：

{{#parameter.x-parameter-extra-annotation}}
    {{parameter.x-parameter-extra-annotation}}
{{/parameter.x-parameter-extra-annotation}}

你可以通过--template-dir参数指定自定义模板目录，让Generator使用修改后的模板生成代码。

内容的提问来源于stack exchange，提问作者user28870581