Как правильно определить повторно используемую ссылку в сваггере? - PullRequest
Новая
       12

Как правильно определить повторно используемую ссылку в сваггере?

0 голосов
/ 12 ноября 2018

Я использую swagger с Open API 3.0.0

Ниже приводится мое определение API: 

paths:
  /offerers:
    get:
      summary: give all offerers back
      operationId: allOfferers
      description: give you all offerers back
      responses:
        '200':
          description: oferers results
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OfferersId'
          links:
            GetSingleOffererById:
              $ref: '#/components/links/GetSingleOffererById'
        '400':
          description: something went terribly wrong
  /offerers/{offererId}:
    parameters:
      - in: path
        name: offererId
        schema:
          $ref: '#/components/schemas/OfferersId'
        required: true
    get: 
      parameters:
        - $ref: '#/components/schemas/OfferersId'
      summary: give one specified offerer back
      operationId: singleOfferer
      description: give one offerer back. Specified by its id
      responses:
        '200':
          description: offerers results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Offerers'
        '400':
          description: something went terribly wrong

components:
  schemas:
    OfferersId:
      type: number
      example: 123
    Offerers:
      type: object
      required:
        - offererId
        - name
      properties:
        id:
          $ref: '#/components/schemas/OfferersId'
        name: 
          type: string
          example: "Mark Mustermann"
        location:
          type: string
          example: "90449 Nürnberg"
        experience:
          type: string
          example: "8 Jahre"
        openingHours:
          type: string
          example: "Werktags: 10:15-18:30/tWochenende: geschlossen."

  links:
    GetSingleOffererById:
      operationId: singleOfferer
      description: the offererId in the response will be used as offererId in the request
      paramters:
        offererId: $reponse.body#/OfferersId

Большая часть этого определения не содержит ошибок.Но в последнем разделе компоненты / ссылки выдает ошибку в строке «operationId: singleOfferer»:

НЕ ДОЛЖЕН иметь дополнительные свойства AdditionalProperty: operationId, paramters

Так что мой вопрос: Как я должен исправить свое определение, чтобы повторная ссылка действительна?

1 Ответ

0 голосов
/ 12 ноября 2018

«НЕ ДОЛЖНО иметь дополнительные свойства» Ошибка в редакторе Swagger обычно означает одно из следующего:

  1. ключевое слово - ошибка,
  2. Синтаксис / структура неверны.

В вашем примере это (1) - paraMTers должно быть paraMETers.

...