自動生成從Java

Question

揚鞭文檔我有這樣的REST服務：

@RestController 
public class ContaCorrenteController { 

    @Autowired 
    private configCorrenteService service; 

    @Produces(MediaType.APPLICATION_JSON) 
    @RequestMapping("/v1/number/{number}/config/{config}/final/{data}") 
    @GET 
    public ResponseEntity<Final> Final(
      @PathVariable("number") Integer number, 
      @PathVariable("config") Integer config, 
      @PathVariable("data") @DateTimeFormat(pattern="yyyyMMdd") LocalDate data) { 
     Final final = service.consultFinal(number, config, data); 
     return ResponseEntity.ok(final); 
    } 

    @Produces(MediaType.APPLICATION_JSON) 
    @RequestMapping("/v1/number/{number}/config/{config}/final") 
    @GET 
    public ResponseEntity<Final> final(
      @PathVariable("number") Integer number, 
      @PathVariable("config") Integer config) { 
     Final final = service.consultFinalNow(number, config); 
     return ResponseEntity.ok(final); 
    } 
} 

我需要使用這個Java文件自動genarete一個REST文檔。 我可以自動生成一個JSON或YAML導入Swagger編輯器或另一種文件的方式？

Answer 1

您可以SpringFox整合：

https://github.com/springfox/springfox

它可以自動生成從Spring的MVC服務器招搖定義。您需要添加一些註釋來有效地記錄文件，但應該非常直截了當。