2017-11-07 9 views
0

私はとspringfox-swagger-uiを自動生成されたRESTのドキュメントに使用しています。swagger-uiで生成されたドキュメントの@PostMappingパラメータを表示するには?

問題:GETリクエストはすべて正常に文書化されています。しかし、POSTリクエストの場合、リクエストボディのパラメータの説明はswagger UIに表示されません。しかし、なぜ?

@RestController 
public class PersonController { 
    @GetMapping 
    public PersonRsp findPerson(PersonDTO p) { 
     //this works just fine an shows the @ApiParam fields in documentation 
    } 

    @PostMapping 
    public PersonRsp updatePerson(@RequestBody PersonDTO p) { 
     //service logic 
     return rsp; 
    } 
} 

class PersonDTO { 
    @ApiParam(required = true, value = "the persons family name") 
    private String lastname; 

    private String firstname; 

    @ApiParam(value = "date of birth in format YYYY-MM-DD") 
    private Date dob; 
} 

質問:どのように私は@ApiParam注釈ヒントが闊歩-UIドキュメントのショーであることで入手できますか?

答えて

0

簡易回答:POSTリクエストには@ApiModelProperty("some description")GETリクエストには@ApiParamを使用する必要があります。

関連する問題