java - Swagger 模型架构不包含主体参数的变量名称

Question

在我的应用程序的 Swagger UI 中，我有 POST 和 PUT 方法，它们都将 POJO 作为 REST 调用中的主体参数。当我查看 UI 并单击“模型架构”以自动填充参数框(只是为了节省输入整个 JSON 的时间)时，它不包含参数名称，因此请求失败。示例:

模型架构:

{ 
   "first": "string",
   "last": "string",
   "address": "string",
   "email": "string",
   .
   .
   .
}

但是，要发出请求，我需要包含参数名称entry，如下所示:

{ "entry": {
   "first": "string",
   "last": "string",
   "address": "string",
   "email": "string",
   .
   .
   .
}}

虽然在发出请求之前自己执行此操作并不太不方便，但它导致其他开发人员在我的应用程序中使用 Swagger UI 时出现问题，并且没有意识到他们需要添加条目。有没有办法修改模型架构？

Answer 1

参数的name不用作body参数中的属性。为了描述您的模型，您可以定义一个具有 object 类型的 entry 属性，如下所示:

definitions:
  Entry:
    type: object
    properties:
      entry:
        type: object
        properties:
          first: 
            type: string
          last:
            type: string
          address:
            type: string
          email:
            type: string

您可以将其用作正文架构，如下所示:

post:
  produces:
    - application/json
  parameters:
    - name: body
      in: body
      schema:
        $ref: '#/definitions/Entry'