多部分POST请求中参数的Swager错误

Question

我正在使用Swagger编辑器来记录Node中内置的现有API，但它一直给我以下错误：

路径上的架构错误。/上载/Rate.post.parameters[0]不完全是来自

此错误出现在我代码的 3 个位置：

• paths./upload/Rate.post。参数[0]
• paths./upload/Rate.post。参数[1]
• paths./users/register.post.parameters[0]

我已经搜索了很多，但例如，这个链接并没有解决我的问题，尽管它是相同的错误：

Swager参数错误”与

这是我对斯威格的定义：

  /users/register:
    post:
      tags:
      - "users"
      description: Allows an user to register at the Server
      produces:
        - application/json
      parameters:
        - name: body
          in: body
          description: JSON Object with information for a Register request from an User
          schema: 
            type: object
            required:
              - username
              - password
              - weight
              - height
              - gender
              - restRate
              - age
            properties:
              username:
                type: string
              password:
                type:
                format: password
              weight:
                type: integer
              height:
                type: integer
              gender:
                type: string
              restRate:
                type: integer
              age: 
                type: integer
      # Expected responses for this operation:
      responses:
        # Response code
        200:
          description: Register successful
          schema:
            type: string

  /upload/Rate:
    post:
      tags:
      - "upload"
      description: Allows an user to upload a file into the server
      produces:
        - application/json
      consumes: 
        - multipart/form-data
      parameters:
        - name: body
          in: formData
          description: JSON Object with information for an upload request from an User
          required: false
          schema:
            type: object
            required:   
              - user
              - overlap
              - window 
              - latitude
              - longitude
              - time
              - date
            properties:
              user:
                type: string
              overlap:
                type: string
              window:
                type: string
              latitude:
                type: string
              longitude:
                type: string
              time:
                type: string
              date:
                type: string
        - name: files 
          in: formData
          description: File with the corresponding Rate
          required: false
          schema:
            type: object
            required:
              - rate
            properties:
              rate:
                type: file
      # Expected responses for this operation:
      responses:
        # Response code
        200:
          description: Login successful
          schema:
            type: string

也许这会有所帮助，但是一旦我解析了它的参数，发布路由（上传/速率）应该会收到一个类似这样的请求：

user = req.body.user;
rr = req.files.rate;
overlap = req.body.overlap;
windowT = req.body.window;
latitude = req.body.latitude;
longitude = req.body.longitude;
time = req.body.time;
date = req.body.date;

感谢您的帮助和时间！

Answer 1

有多个问题。

/upload/register：

• 架构属性密码缺少type的值。
• 属性名称不匹配-rest HR（在属性下）与rest的（在必需的列表中）。

< code >上传/费率:

>

这里的问题是由多部分/form-data请求中的对象参数引起的。在OpenAPI（fka Swagger）2.0中，表单参数可以是原始值和数组，但不能是对象。因此，您的示例无法使用OpenAPI 2.0进行描述。

如果您正在设计一个新的API(或者如果您能够并且愿意更改API实现以兼容OpenAPI 2.0)，可能的解决方案是:

< li >更改操作以使用< code>application/json,并将所有输入参数组合成一个json对象。file参数需要以base64 string-< code > type:string 和< code>format: byte的形式实现。 < li >使用< code>multipart/form-data,但将对象参数拆分为单独的表单参数。

< br >即将推出的OpenAPI 3.0将支持表单数据中的对象参数:< br > https://github . com/OAI/open API-Specification/blob/open API . next/versions/3.0 . MD # special-considerations-for-multipart-content