In Swagger, ist es möglich, mehrere Yaml-Dateien in einer einzigen Datei zu importieren?

Question

Für den Client diese eine innerhalb von client.yaml ist

/clients: 
    get: 
     tags: 
     - "Clients" 
     description: "List Clients The list capability" 
     produces: 
     - "application/json" 
     parameters: 
     - name: "tenantIdentifier" 
     in: "query" 
     required: true 
     type: "array" 
     items: 
      type: "string" 
      enum: 
      - "default" 
     responses: 
     200: 
      description: "successful operation" 
     400: 
      description: "Invalid status value" 
     security: 
     - basicAuth: [] 
    post: 
     tags: 
     - "Clients" 
     summary: "Create client if address is enabled" 
     description: "" 
     operationId: "addClient" 
     consumes: 
     - "application/json" 
     produces: 
     - "application/json" 
     parameters: 
     - name: "tenantIdentifier" 
     in: "query" 
     description: "" 
     required: true 
     type: "array" 
     items: 
      type: "string" 
      enum: 
      - "default" 
     - in: "body" 
     name: "body" 
     description: "Add what do you wnat to add " 
     required: true 
     schema: 
      allOf: 
      - $ref: '#/definitions/ClientStructure1' 
      - $ref: '#/definitions/ClientStructure2' 
      - $ref: '#/definitions/ClientStructure3' 
     responses: 
     405: 
      description: "Invalid input" 
     security: 
     - basicAuth: [] 

Für den Anwender ist dieser innerhalb von user.yaml

/users: 
    get: 
     tags: 
     - "Users" 
     summary: "Retrieve list of users" 
     produces: 
     - "application/json" 
     parameters: 
     - name: "tenantIdentifier" 
     in: "query" 
     required: true 
     type: "array" 
     items: 
      type: "string" 
      enum: 
      - "default" 
     responses: 
     200: 
      description: "successful operation" 
     400: 
      description: "Invalid status value" 
     security: 
     - basicAuth: [] 
    post: 
     tags: 
     - "Users" 
     summary: "Adds new application user." 
     description: "Note: Password information is not required (or processed). Password details at present are auto-generated and then sent to the email account given (which is why it can take a few seconds to complete)." 
     consumes: 
     - "application/json" 
     produces: 
     - "application/json" 
     parameters: 
     - name: "tenantIdentifier" 
     in: "query" 
     description: "" 
     required: true 
     type: "array" 
     items: 
      type: "string" 
      enum: 
      - "default" 
     - in: "body" 
     name: "body" 
     description: "Mandatory Fields: username, firstname, lastname, email, officeId, roles, sendPasswordToEmail" 
     required: true 
     schema: 
      $ref: "#/definitions/StructureForCreateUSer"   
     responses: 
     400: 
      description: "" 
     404: 
      description: "" 
     security: 
     - basicAuth: [] 

Answer 1

OpenAPI 3 die Verwendung des $ ref Schlüsselwort erlaubt:

https://swagger.io/docs/specification/using-ref/

Answer 2

Sie können nicht $ref ganze Pfade, aber Sie können den Inhalt einzelner p $ref aths. In Ihrem Beispiel können Sie verwenden:

paths: 
    /clients: 
    $ref: clients.yaml#/~1clients 
    /users: 
    $ref: users.yaml#/~1users 

clients.yaml#/~1clients bedeutet nehmen wir die clients.yaml Datei, dann den Inhalt des /clients Knoten in der Datei lesen und die $ref mit, dass Inhalte ersetzen. ~1clients ist /clients mit / Escape als ~1 nach JSON Pointer-Regeln.

die Referenzen zu vereinfachen, können Sie die /clients: und /users: Knoten von Ihren clients.yaml und users.yaml Dateien

# clients.yaml 
get: 
    description: "List Clients The list capability" 
    ... 
post: 
    summary: "Create client if address is enabled" 
    ... 

und dann

paths: 
    /clients: 
    $ref: clients.yaml 
    /users: 
    $ref: users.yaml