java - 从 Java 自动生成 Swagger 文档

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 定义。您需要添加一些注释才能有效地记录内容，但这应该非常简单明了。