Swagger / OpenAPI - Verwenden Sie $ ref, um einen wiederverwendbaren definierten Parameter zu übergeben

Sagen wir, ich habe einen parameter wie limit. Diese bekommt man überall auf der Welt verwendet und es ist ein Schmerz, um es zu ändern, überall, wenn ich brauche, um Sie zu aktualisieren:

parameters:
    - name: limit
      in: query
      description: Limits the number of returned results
      required: false
      type: number
      format: int32

Kann ich mit $ref zu definieren, diese an anderer Stelle und machen es wiederverwendbar? Ich kam in dieses ticket was darauf hindeutet, dass jemand will, zu ändern oder zu verbessern Funktion, aber ich kann nicht sagen, ob es bereits heute existiert, oder nicht?

InformationsquelleAutor der Frage brandonscript | 2014-11-18

  1. 108

    Diese Funktion existiert bereits in Swagger 2.0. Die verknüpfte ticket-Gespräche über bestimmte mechanik, die keinen Einfluss auf die Funktionalität von diesem feature.

    Auf dem top-level-Objekt (im folgenden bezeichnet als die Swagger-Objekt), es gibt eine parameters Grundstück, wo Sie der Definition von wieder verwendbaren Parameter. Sie können geben Sie dem parameter einen beliebigen Namen, und finden Sie Wege/spezifische Operationen. Die top-level-Parameter sind nur Definitionen und werden nicht angewendet, um alle Operationen in der Spezifikation automatisch.

    Finden Sie ein Beispiel für die es hier - https://github.com/swagger-api/swagger-spec/blob/master/fixtures/v2.0/json/resources/reusableParameters.json - auch mit einer limit-parameter.

    In Ihrem Fall, würden Sie wollen, dies zu tun:

    # define a path with parameter reference
/path:
   get:
      parameters:
         - $ref: "#/parameters/limitParam"

# define reusable parameters:
parameters:
   limitParam:
      name: limit
      in: query
      description: Limits the number of returned results
      required: false
      type: integer
      format: int32

    InformationsquelleAutor der Antwort Ron

Schreibe einen Kommentar