Автоматически генерировать Swagger документацию от 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); 
    } 
} 

мне нужно автоматически genarete документацию REST с помощью этого Java-файл. Могу ли я автоматически генерировать json или yaml для импорта в редакторе Swagger или другим способом для документации?

Answer 1

Вы можете интегрировать с SpringFox:

https://github.com/springfox/springfox

который может автоматически генерировать определения чванство с сервера Spring-MVC. Вам нужно будет добавить некоторые аннотации, чтобы эффективно документировать вещи, но это должно быть довольно прямолинейно.