32

所以我明白，如果我们想要身体参数，我们必须有一个模式，我就是这样做的。问题是无论我如何尝试定义我的架构，它都不允许我拥有多个正文参数。这是我尝试过的方法之一的示例。任何帮助都会很棒！

swagger: '2.0'

# This is your document metadata
info:
  version: "0.0.1"
  title: Todo App
schema: {
        }
host: localhost:3000
schemes:
  - http
  - https
consumes:
  - application/json
produces:
  - application/x-www-form-urlencoded
basePath: /

paths:
  # This is a path endpoint. Change it.
  /tasks:
    post:
      description: |
        Add 'Task' object.

      parameters:
        # An example parameter that is in query and is required
        -
          name: name 
          in: query
          description: unique object task name
          required: true
          schema:
            type: string
        - name: description
          in: query
          description: task description
          required: true
          schema:
            type: string

      responses:
        # Response code
        200: 
          description: Successful response
          # A schema describing your response object.
          # Use JSON Schema format
          schema:
              title: Return String
              type: string
              example: "Task added succesfully"
        500:
          description: Error
          schema: 
            type: string
            example: "Could not add Task"
4

2 回答 2

40

我不确定你的问题...

  • 如果您尝试为一项操作定义多个主体参数，则不能。如招摇规范中所述：

Body [...] 只能有一个 body 参数

  • 如果您尝试发送具有多个参数的主体，请在定义部分添加一个对象模型并在您的主体参数中引用它，见下文（与editor.swagger.io一起使用）：

您的示例节点也是错误的，请参阅此处了解更多详细信息。

swagger: '2.0'
info:
  version: "0.0.1"
  title: Todo App
host: localhost:3000
schemes:
  - http
  - https
consumes:
  - application/json
produces:
  - application/x-www-form-urlencoded
basePath: /
paths:
  # This is a path endpoint. Change it.
  /tasks:
    post:
      description: |
        Add 'Task' object.
      parameters:
        - name: task 
          in: body
          description: task object
          required: true
          schema:
            $ref: '#/definitions/Task'
      responses:
        200:
          description: Successful response
          schema:
              title: Return String
              type: string
              example: "Task added succesfully"
        500:
          description: Error
          schema: 
            type: string
            example: "Could not add Task"
definitions:
  Task:
    description: Task object
    properties:
      name:
        type: string
        description: task object name
      description:
        type: string
        description: task description
    required:
      - name
      - description
于 2015-06-24T19:34:16.180 回答
6

您还可以将请求正文参数的属性properties用作其schema. 这在对象有效负载下有一个很好的例子：https ://swagger.io/docs/specification/2-0/describing-request-body/ 。

paths:
  /users:
    post:
      summary: Creates a new user.
      consumes:
        - application/json
      parameters:
        - in: body
          name: user
          description: The user to create.
          schema:
            type: object
            required:
              - userName
            properties:
              userName:
                type: string
              firstName:
                type: string
              lastName:
                type: string
      responses:
        201:
          description: Created

当然，缺点是您无法重用对象定义，但有时对象定义并不合适。

于 2017-10-18T19:05:18.813 回答