2016-04-11 34 views
0

Şu anda Swagger UI bileşeninde JSON'u kaydırmanın bir yolunu arıyorum.JSON nesnelerini nasıl sarabilirim?

YAML olarak benim nesne beyanıdır:

restException: 
    properties: 
     message: 
     type: string 

Swagger Arayüzü tarafından oluşturulur çıkışı (Kabul ediyorum yüklenebileceğini, doğrudur) 'dir: { "message": "string" }

ve ne istiyorum geçerli:

"restException": { 
    "message": "string" 
} 

Sarıcıyı YAML dosyasında açıkça bildirerek bunu yapmak için çirkin bir yol buldum. Ancak, istemci veya sunucu kodu oluşturmak için "Swagger Codegen" kullandığımda da üretildiğinden ötürü çok kötü.

restExceptionContainer: restException: properties: message: type: string

Ben gerekirse Swagger UI dosyasındaki kod ekleme iyiyim! Bulmak için yardıma ihtiyacım var :)

cevap

2

RestException öğesini nesne (type: object) olarak belirlemelisiniz.

Örnek olarak https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/test/resources/2_0/petstore.yaml#L646'a bakın ve Pet ve Kategorinin nasıl tanımlandığına bakın.

Category: 
    type: object 
    properties: 
     id: 
     type: integer 
     format: int64 
     name: 
     type: string 
: Kategori olarak tanımlanır

Pet: 
    type: object 
    required: 
     - name 
     - photoUrls 
    properties: 
     id: 
     type: integer 
     format: int64 
     category: 
     $ref: '#/definitions/Category'