2015-05-11 10 views
7

Ho provato a cambiare il basePath nel mio file json, che sembra cambiare solo il "baseurl" inferiore dell'interfaccia utente swagger. Voglio sbarazzarmi del "Default" che appare come un titolo di gruppo della mia interfaccia utente swagger. Qualcuno è stato in grado di risolvere questo problema? Sto usando Swagger ~ 2.0.Come modificare il percorso "predefinito" di Swagger-UI

risposta

13

Il Default non è un percorso, è un tag.

In Swagger 2.0, il raggruppamento viene eseguito utilizzando i tag. Ogni operazione può essere assegnata a zero o più tag. Nell'interfaccia utente, qualsiasi operazione senza tag termina sotto il gruppo Default.

"/pet/findByStatus": { 
    "get": { 
    "tags": [ 
     "pet" 
    ], 
    "summary": "Finds Pets by status", 
    "description": "Multiple status values can be provided with comma seperated strings", 
    "operationId": "findPetsByStatus", 
    "consumes": [ 
     "application/xml", 
     "application/json", 
     "multipart/form-data", 
     "application/x-www-form-urlencoded" 
    ], 
    "produces": [ 
     "application/xml", 
     "application/json" 
    ], 
    "parameters": [ 
     { 
     "name": "status", 
     "in": "query", 
     "description": "Status values that need to be considered for filter", 
     "required": false, 
     "type": "array", 
     "items": { 
      "type": "string" 
     }, 
     "collectionFormat": "multi", 
     "default": "available", 
     "enum": [ 
      "available", 
      "pending", 
      "sold" 
     ] 
     } 
    ], 
    "responses": { 
     "200": { 
     "description": "successful operation", 
     "schema": { 
      "type": "array", 
      "items": { 
      "$ref": "#/definitions/Pet" 
      } 
     } 
     }, 
     "400": { 
     "description": "Invalid status value" 
     } 
    }, 
    "security": [ 
     { 
     "petstore_auth": [ 
      "write:pets", 
      "read:pets" 
     ] 
     } 
    ] 
    } 
} 

È possibile visualizzare le operazioni ha una proprietà tags con il valore di "pet", e tale operazione sarebbero raggruppate sotto tale intestazione.

+0

Grazie, ho capito ora! – Shawn123

+0

Forse utile sapere che in Swagger PHP, questo output JSON sarebbe generato aggiungendo quanto segue all'annotazione '@SWG \ Get' o' @SWG \ Post' (o qualunque sia il tipo 'Operation'):' tag = {"pet"} ' –

+2

Assicurati di aggiungere la sezione 'tag' nella parte superiore del tuo documento, in modo che tu possa includere una bella descrizione per il tag. (Come mostrato nell'esempio di Ron sopra) – TomH

Problemi correlati