OpenAPI 生成器不考虑多部分多文件上传的字段名称

Question

我有一个用 OpenAPI 描述的 API，它将在 Java/Kotlin 中实现，所以我使用 kotlin-spring generation 进行代码生成，使用 OpenAPI 3.0.2 和插件“org.openapi.generator”版本“ 6.2.1"

我的问题是模式中包含将要上传的文件的字段始终命名为file，而不是尊重我指定的名称attachments，也许这是我不知道的标准，但这是一个已经在使用 attachments 的现有 API，我想保留该名称。

这是模式：

  /emails/send:
post:
  responses:
    "200":
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EmailSendResponse'
      description: Response from the send email request.
  operationId: sendEmail
  requestBody:
    required: true
    content:
      multipart/form-data:
        schema:
          $ref: '#/components/schemas/EmailSendRequest'

和请求模式：

EmailSendRequest:
  title: Email send request
  description: Contains the data required to send an email.
  required:
    - success
    - failureReason
  type: object
  properties:
    from:
      type: string
    to:
      type: string
    subject:
      type: string
    content:
      type: string
    contentType:
      type: string
      enum:
        - HTML
        - TEXT
    bcc:
      type: string
    tags:
      type: array
      items:
        type: string
    category:
      type: string
    attachments:
      type: array
      items:
        type: string
        format: binary

这是在 Java 中生成的 API 方法：

@RequestMapping(
        method = [RequestMethod.POST],
        value = ["/emails/send"],
        produces = ["application/json"],
        consumes = ["multipart/form-data"]
)
fun sendEmail(@Parameter(description = "") @RequestParam(value = "from", required = false) from: kotlin.String? ,@Parameter(description = "") @RequestParam(value = "to", required = false) to: kotlin.String? ,@Parameter(description = "") @RequestParam(value = "subject", required = false) subject: kotlin.String? ,@Parameter(description = "") @RequestParam(value = "content", required = false) content: kotlin.String? ,@Parameter(description = "", schema = Schema(allowableValues = ["HTML", "TEXT"])) @RequestParam(value = "contentType", required = false) contentType: kotlin.String? ,@Parameter(description = "") @RequestParam(value = "bcc", required = false) bcc: kotlin.String? ,@Parameter(description = "") @RequestParam(value = "tags", required = false) tags: kotlin.collections.List<kotlin.String>? ,@Parameter(description = "") @RequestParam(value = "category", required = false) category: kotlin.String? ,@Parameter(description = "file detail")  @RequestPart("file") attachments: kotlin.collections.List<org.springframework.core.io.Resource>?): ResponseEntity<EmailSendResponse> {
    return ResponseEntity(HttpStatus.NOT_IMPLEMENTED)
}

如您所见，它生成的是 @RequestPart("file") 而不是 @RequestPart("attachments")

有什么线索吗？我一直在查看文档，但找不到任何内容。

谢谢！

Answer 1

这似乎是 kotlin 生成器的问题。我使用您为 kotlin-spring generated 和 spring generator 提供的模式运行生成器。 java 方法具有正确的值 @RequestPart

default ResponseEntity<String> sendEmail(
        @Parameter(name = "from", description = "") @Valid @RequestParam(value = "from", required = false) String from,
        @Parameter(name = "to", description = "") @Valid @RequestParam(value = "to", required = false) String to,
        @Parameter(name = "subject", description = "") @Valid @RequestParam(value = "subject", required = false) String subject,
        @Parameter(name = "content", description = "") @Valid @RequestParam(value = "content", required = false) String content,
        @Parameter(name = "contentType", description = "") @Valid @RequestParam(value = "contentType", required = false) String contentType,
        @Parameter(name = "bcc", description = "") @Valid @RequestParam(value = "bcc", required = false) String bcc,
        @Parameter(name = "tags", description = "") @Valid @RequestParam(value = "tags", required = false) List<String> tags,
        @Parameter(name = "category", description = "") @Valid @RequestParam(value = "category", required = false) String category,
        @Parameter(name = "attachments", description = "") @RequestPart(value = "attachments", required = false) List<MultipartFile> attachments
    ) {
        return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
    }

但是生成的 kotlin 方法没有

  fun sendEmail(@Parameter(description = "") @RequestParam(value = "from", required = false) from: kotlin.String?,
                @Parameter(description = "") @RequestParam(value = "to", required = false) to: kotlin.String?,
                @Parameter(description = "") @RequestParam(value = "subject", required = false) subject: kotlin.String?,
                @Parameter(description = "") @RequestParam(value = "content", required = false) content: kotlin.String?,
                @Parameter(description = "") @RequestParam(value = "contentType", required = false)
                contentType: kotlin.String?,
                @Parameter(description = "") @RequestParam(value = "bcc", required = false) bcc: kotlin.String?,
                @Parameter(description = "") @RequestParam(value = "tags", required = false)
                tags: kotlin.collections.List<kotlin.String>?,
                @Parameter(description = "") @RequestParam(value = "category", required = false)
                category: kotlin.String?, @Parameter(description = "file detail") @Valid @RequestPart("file")
                attachments: kotlin.collections.List<org.springframework.core.io.Resource>?): ResponseEntity<kotlin.String> {
    return ResponseEntity(HttpStatus.NOT_IMPLEMENTED)
  }

如果这对您来说是一个交易破坏者，那么我建议使用 java 生成器生成代码。 Kotlin 和 java 是完全兼容的，所以你仍然可以在你的 kotlin 类中使用生成的类和方法。

我还建议在 openapi generator wiki 上推荐 filing a bug report 以引起对该问题的关注。