2015-05-11 23 views
7

Jumper dosyamda basePath'i değiştirmeyi denedim, bu yalnızca swagger-UI'nin alt "baseurl" değerini değiştiriyor gibi görünüyor. Benim swagger-UI grubunun bir grup başlığı olarak görünen "Varsayılan" dan kurtulmak istiyorum. Bu sorunu çözebilecek biri var mı? Swagger ~ 2.0 kullanıyorum.Swagger-UI "Varsayılan" yolu nasıl değiştirilir?

cevap

13

Default bir yol değil, bir etiket.

Swagger 2.0'da, gruplandırma etiketleri kullanılarak yapılır. Her işlem sıfır veya daha fazla etikete atanabilir. Kullanıcı arayüzünde, etiketi olmayan herhangi bir işlem, Default grubu altında sonuçlanacaktır.

"/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" 
     ] 
     } 
    ] 
    } 
} 

Sen işlemleri görebilirsiniz "pet" değerine sahip bir tags özelliğine sahiptir ve bu operasyonun bu başlığı altında gruplandırılır.

+0

Teşekkür ederim, şimdi anladım! – Shawn123

+0

Swagger PHP'de, bu JSON çıktısının '@SWG \ Get' veya' @SWG \ Post' ek açıklamalarına (ya da 'Operation' türünüz ne olursa olsun) aşağıdakileri ekleyerek oluşturulacağını bilmek yararlı olabilir:' tags = {"pet"} ' –

+2

Etiket için güzel bir açıklama ekleyebilmeniz için, 'etiketler' bölümünü dokümanınızın en üst kısmına ekleyeceğinizden emin olun. (Yukarıda Ron'un örneğinde gösterildiği gibi) – TomH

İlgili konular