web-dev-qa-db-de.com

Wie beschreibt man diesen POST JSON Request Body in OpenAPI (Swagger)?

Ich habe eine POST Anfrage, die den folgenden JSON-Anfragetext verwendet. Wie kann ich diesen Anfragetext mit OpenAPI (Swagger) beschreiben?

{
    "testapi": {
        "testapiContext": {
            "messageId": "kkkk8",
            "messageDateTime": "2014-08-17T14:07:30+0530"
        },
        "testapiBody": {
            "cameraServiceRq": {
                "osType": "Android",
                "deviceType": "samsung555"
            }
        }
    }
}

Bisher habe ich Folgendes versucht, bin aber bei der Definition des Körpers festgefahren schema.

swagger: "2.0"
info:
  version: 1.0.0
  title: get camera
  license:
    name: MIT
Host: localhost
basePath: /test/service
schemes:
  - http
consumes:
  - application/json
produces:
  - application/json
paths:
  /getCameraParameters:
    post:
      summary: Create new parameters
      operationId: createnew
      consumes:
        - application/json
        - application/xml
      produces:
        - application/json
        - application/xml
      parameters:
        - name: pet
          in: body
          description: The pet JSON you want to post
          schema:  # <--- What do I write here?

          required: true
      responses: 
        200: 
          description: "200 response"
          examples: 
            application/json: 
             {
               "status": "Success"
             }

Ich möchte den Eingabetext inline als Beispiel für die Dokumentation definieren.

40

Ich habe es funktioniert mit:

    post:
      consumes:
        - application/json
      produces:
        - application/json
        - text/xml
        - text/html
      parameters:
        - name: body
          in: body
          required: true
          schema:
            # Body schema with atomic property examples
            type: object
            properties:
              testapi:
                type: object
                properties:
                  messageId:
                    type: string
                    example: kkkk8
                  messageDateTime:
                    type: string
                    example: '2014-08-17T14:07:30+0530'
              testapiBody:
                type: object
                properties:
                  cameraServiceRq:
                    type: object
                    properties:
                      osType:
                        type: string
                        example: Android
                      deviceType:
                        type: string
                        example: samsung555
            # Alternatively, we can use a schema-level example
            example:
              testapi:
                testapiContext:
                  messageId: kkkk8
                  messageDateTime: '2014-08-17T14:07:30+0530'
                testapiBody:
                  cameraServiceRq:
                    osType: Android
                    deviceType: samsung555
37

Die am besten lesbare Möglichkeit, einen mehrzeiligen Skalar in YAML aufzunehmen, ist die Verwendung von Blockliteralstil . Dies erfordert, dass Sie Ihr JSON-Beispiel nur mit Einrückung ändern (die entfernt wird, wenn Sie den Wert für den Schlüssel abrufen):

.
.
produces:
  - application/json
example: |
  {
      "testapi": {
          "testapiContext": {
              "messageId": "kkkk8",
              "messageDateTime": "2014-08-17T14:07:30+0530"
     },
          "testapiBody": {
              "cameraServiceRq": {
                  "osType": "Android",
                  "deviceType": "samsung555"
              }
          }
      }
  }
paths:
  /getCameraParameters:
.
.

(Aus Gründen der Übersichtlichkeit können Sie ein oder zwei zusätzliche Zeilen vor den Skalar-Schlüssel paths einfügen. Sie erhalten standardmäßig abgeschnitten für die Skalare im Literalblockstil.

4
Anthon