スワッガーエディタでapiのパラメータとしてカスタムオブジェクトを表現する方法

Question

swagger-editorでapiのパラメータとしてカスタムオブジェクトを表現したいと思います。

class Info 
{ 
    private String id; 
    private String name; 
    private String desc; 
} 

どのようにこれはYAML文書として闊歩エディタで表すことができます？パラメータとして情報モデルクラスが含まれている、我々は法の上に/postInfo /データ

@RequestMapping(value = "/postInfo/data", method = RequestMethod.POST) 
public Info requestProcessing(@RequestBody Info info) 
{ 
    // Implementation 
} 

をAPIを呼び出していると言うことができますか闊歩2.0で

Answer 1

、オブジェクト・スキーマは、グローバルdefinitionsセクションで定義することができる：スペックの他の部分から

definitions: 
    Info: 
    type: object 
    properties: 
     id: 
     type: string 
     name: 
     type: string 
     desc: 
     type: string 

、次いで$ref「ED。

オブジェクトに操作の入力が使用されている場合、操作では、そのオブジェクトのスキーマに対応するschemaの本体パラメーターを定義する必要があります。

paths: 
    /postInfo/data: 
    post: 
     consumes: 
     - application/json 
     parameters: 
     - in: body 
      name: body 
      required: true 
      schema: 
      $ref: '#/definitions/Info' 
     responses: 
     200: 
      description: OK