2015-07-06 15 views
6

bunu yapabilirim:Biçimlendirici bir yanıt nesnesine nasıl başvurulur?

parameters: 
    avatarSizeParam: 
    name: size 
    in: query 
    description: Size of avatar. 
    enum: [32, 64] 
    required: false 
    type: integer 
    format: int32 

paths: 
    /my/path/avatar: 
    get: 
     parameters: 
     - $ref: '#/parameters/avatarSizeParam' 

İyi. Swagger, Parameter Objects'u yeniden tanımlamak için parameters anahtarını tanımlar; burada yeniden kullanmak için .

responses: 
    notFoundResponse: 
    description: Entity not found. 
    schema: 
     $ref: '#/definitions/schema404' 

Ben de bu işe görünmüyor aşağıdaki

paths: 
    /my/path/avatar: 
    get: 
     parameters: 
     - $ref: '#/parameters/avatarSizeParam' 
     responses: 
     - $ref: '#/responses/notFound' 

benim önceki yol tanımını genişletmek varsaymışlardı: Ayrıca şöyle Response Objects tanımlayabilirsiniz bir responses anahtarı tanımlar ancak. Operations Object için the spec'a geri döndüm ve parameters bir Reference Object olabilir, ancak responses yapamazsınız fark ettim.

Operation Object definiton (partial)

orada öğeleri başvuramaz if (en üstteki düzeyde responses) bir Yanıtları Tanımlar Nesne izin anlamı nedir? Bunu yapmanın bir yolu var mı? Eğer here görürseniz

cevap

16

, bir anahtar olarak HTTP Durum Kodu tanımlamak zorunda, sonra doğru sözdizimi şöyledir:

paths: 
    /my/path/avatar: 
    get: 
     parameters: 
     - $ref: '#/parameters/avatarSizeParam' 
     responses: 
     404: 
      $ref: '#/responses/notFound' 
+0

teşekkür ederiz! Evet bu çok mantıklı. 'Answeres' un bir nesne olduğunu ve bir hahah dizisi olmadığını unuttum –

İlgili konular