go-swagger - 数组作为请求正文中的对象

一分耕耘，一分收获！既然打开了这篇文章《go-swagger - 数组作为请求正文中的对象》，就坚持看下去吧！文中内容包含等等知识点...希望你能在阅读本文后，能真真实实学到知识或者帮你解决心中的疑惑，也欢迎大佬或者新人朋友们多留言评论，多给建议！谢谢！

我正在使用 go-swagger 为我们的 api 生成 swagger 文件 我一直在尝试为获取请求中的对象数组的 api 添加注释，但 go-swagger 似乎无法识别它

我的请求在 json 格式中看起来像这样：

{
  [
    {
      "name": "title1",
      "label": "tag1",
      "sort": true
    },
    {
      "name": "title2",
      "label": "tag2",
      "sort": true
    }
  ]
}

这就是我现在的评论

// swagger:route post /admin/qc qc createqc
//
// creates a new qc.
//
//
//     consumes:
//     - application/json
//
//     produces:
//     - application/json
//
//     schemes: https
//
//     deprecated: false
//
//
//     parameters:
//       + name: authorization
//         in: header
//         required: true
//         type: string
//
//       + name: input
//         in: body
//         required: true
//         type: array
//         items: qc
//
//     responses:
//       200: statusok

这是生成的swagger文件

/admin/qc:
    post:
      consumes:
      - application/json
      operationId: createQC
      parameters:
      - in: header
        name: Authorization
        required: true
        type: string
      - in: body
        name: input
        required: true
        schema:
          type: array
      produces:
      - application/json
      responses:
        "200":
          description: StatusOK
          schema:
            $ref: '#/definitions/StatusOK'
      schemes:
      - https
      summary: Creates a new QC.
      tags:
      - QC

go-swagger 不会拾取此注释中的项目类型。 遗憾的是，更改此 api 请求类型的选项不可用。

有人知道我应该如何注释它吗？

正确答案

为了注释这种类型的请求，您需要定义一个如下所示的新结构：

// swagger:parameters createQC
type CreateQCReqs struct {
    // in: body
    Body []*CreateQCReq
}

您需要使用 swagger:parameters 进行注释，后跟 api 的操作 id
之后，您需要使用所需的数据类型定义 body 字段 就我而言，它是一个 createqcreq 数组
之后你需要删除swagger:route中的body参数，否则你的swagger文件中的body字段将生成2次

今天关于《go-swagger - 数组作为请求正文中的对象》的内容介绍就到此结束，如果有什么疑问或者建议，可以在golang学习网公众号下多多回复交流；文中若有不正之处，也希望回复留言以告知！