32

したがって、本体パラメーターが必要な場合は、スキーマが必要であることを理解しています。問題は、スキーマをどのように定義しようとしても、複数の本体パラメーターを持つことができないことです。これは私が試した方法の1つの例です。どんな助けでも素晴らしいでしょう！

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

あなたの質問がよくわかりません...

  • 1 つの操作に対して複数の body パラメーターを定義しようとしても、できません。swagger仕様で説明されているように：

ボディ [...] ボディ パラメータは 1 つしか存在できません

  • 複数のパラメーターを持つ本文を送信しようとしている場合は、オブジェクト モデルを定義セクションに追加し、それを 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 に答える