模仿yaag中间件生成swagger.json文件-优快云博客

本文链接：https://blog.youkuaiyun.com/xyjworkgame/article/details/107397472

本文介绍了一款名为siwag的中间件，它能够记录每次请求的参数与响应，通过对比前后参数判断必填项，并在启动web后自动生成swagger定义。尽管存在如query参数类型识别不全等缺点，但其对常见请求格式的支持使其成为API文档自动生成的有效工具。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

模仿yaag中间件写一个siwag

siwag中间件

siwag中间件

导入中间件能够生成swagger.json 文件，

特点：

1. 每次请求都能够记录参数和响应（虽然参数类型有的获取不到例如 query的参数）

2. 能够根据前后参数对比，发现参数是否是必须的要求

3. 启动web后，会自动扫描自己添加的struct能够生成definitions，（能省自己一步是一步）

缺点：

1. query 因为后端得到的都是字符串，我这里没有尝试格式化得到类型。（还没有完善）

2. struct 构造导致body参数与query 参数的type 出现问题（body参数没有type 键）

3. 只能够记录application/json 等常见的请求格式

下面是生成的swagger.json 下面是路径的重要重写

"paths": {
    "/json": {
      "post": {
        "description": "",
        "consumes": [
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json"
        ],
        "schemes": null,
        "tags": [
          "default"
        ],
        "summary": "",
        "deprecated": false,
        "parameters": [
          {
            "in": "path",
            "name": "cesa",
            "required": true,
            "type": "",
            "allowEmptyValue": false,
            "description": "{\"aaa\":\"2,3,4\",\"cesa\":\"1,2,2,2,2\"}"
          },
          {
            "in": "path",
            "name": "aaa",
            "required": true,
            "type": "",
            "allowEmptyValue": false,
            "description": "{\"aaa\":\"2,3,4\",\"cesa\":\"1,2,2,2,2\"}"
          }
        ],
        "responses": {
          "200": {
            "description": "1,2,2,2,2"
          }
        }
      }
    }
  },