2015-08-19 12 views
12

Ist es möglich, mehrere Parameter zu gruppieren, um sie in mehreren Routen zu referenzieren?Wie gruppiert man mehrere Parameter in Swagger 2.0?

Zum Beispiel habe ich eine Kombination von Parametern, die ich in jeder Route brauche. Sie sind als globale Parameter definiert. Wie kann ich sie gruppieren?

Ich denke über eine Definition wie folgt aus:

parameters: 
    MetaDataParameters: 
    # Meta Data Properties 
    - name: id 
     in: query 
     description: Entry identification number 
     required: false 
     type: integer 

    - name: time_start 
     in: query 
     description: Start time of flare 
     required: false 
     type: string 

    - name: nar 
     in: query 
     description: Active region number 
     required: false 
     type: string 

Und dann die ganze Gruppe in meiner Route Referenz:

/test/: 
    get: 
    tags: 
     - TEST 
    operationId: routes.test 
    parameters: 
     - $ref: "#/parameters/MetaDataParameters" 
    responses: 
     200: 
      description: OK 

Ist dies möglich mit Swagger 2.0?

+2

Basierend auf meinem Wissen, es ist nicht möglich, Gruppenparameter und verweisen auf die gesamte Gruppe in einer Route aber das Gefühl frei zu machen der Vorschlag [hier] (https://github.com/swagger-api/swagger-spec/issues) für zukünftige Verbesserung –

+0

Ok danke, es war meine Absicht, einen Vorschlag zu erstellen, aber ich wollte klar sein, dass es tut nicht schon vorhanden. – cansik

Antwort

Verwandte Themen