スワッガー：フォーマット例json

Question

レスポンスのexamplesセクションの形式を理解することは本当に苦労しています。 500 Internal Severエラーに対して以下の応答が定義されています。

500InternalServerError: 
    description: The server encountered an unexpected condition which prevented it from fulfilling the request 
    schema: 
     allOf: 
     - $ref: '#/definitions/Failure' 
    headers: 
     X-Rate-Limit-Limit: 
     description: The number of allowed requests in the current period 
     type: integer 
     X-Rate-Limit-Remaining: 
     description: The number of remaining requests in the current period 
     type: integer 
     X-Rate-Limit-Reset: 
     description: The number of seconds left in the current period 
     type: integer 
    examples: 
     application/json: 
     code: -1 
     message: The server encountered an unexpected condition which prevented it from fulfilling the request 

私は威張っ-UIでそれをロードすると、それは次のようになります。私は応答が複数行の上にフォーマットされ、このように見える？：

するために取得するにはどうすればよい

{ 
    "code": "-1", 
    "message": "The server encountered an unexpected condition which prevented it from fulfilling the request" 
} 

Answer 1

レスポンスレベルの例では、Swagger UI 3.0.xのバグや機能が不足しているようです。お気軽にon GitHubと提出してください。 （他の項目と組み合わせずに）単独の$refを使用しているとき、あなたはallOfを必要としないところで

definitions: 
    Failure: 
    type: object 
    ... 
    example: 
     code: "-1" # Quotes force the number to be treated as a string 
     message: The server encountered an unexpected condition which prevented it from fulfilling the request 

：

この問題を回避するには、代わりに、スキーマ・レベルの例を使用することです

schema: 
    $ref: '#/definitions/Failure'