从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文件自动生成REST文档。 我可以自动生成json或yaml以在Swagger编辑器上导入或以其他方式导入文档吗？

Answer 1

您可以与SpringFox集成：

https://github.com/springfox/springfox

可以从Spring-MVC服务器自动生成swagger定义。您需要添加一些注释来有效地记录事物，但它应该非常直接。