java - Java Spring 应用程序可以利用 swagger 吗？

Question

我一直在研究 swagger 作为一种为我的团队的 api 自动生成文档的可能方法 http://swagger.io/getting-started/ 。看起来很有希望，但我发现他们的文档缺乏。

话虽如此，我有一些非常基本的问题。

1. 是否可以仅在 Spring 应用程序中使用 swagger？我们的应用程序既不是 Jersey 也不是 JAX-RS 应用程序。有谁知道普通的 Spring 应用程序是否可以与 swagger 一起使用？如果是的话，可以提供链接或一组说明吗？

我找到了这个链接http://blog.zenika.com/index.php?post/2013/07/11/Documenting-a-REST-API-with-Swagger-and-Spring-MVC然而，他们略过有关设置属性文件的部分。

swagger 在其网站上引用了许多不同的工具:swagger core、codegen、ui 和 swagger editor。生成基本 API 文档只需要 swagger-core 还是需要组合使用 swagger 工具？

Answer 1

有一个页面专门用于 support swagger frameworks .

您正在寻找的是SpringFox .

Automated JSON API documentation for API's built with Spring

基本上，您可以使用指向您的 API 上下文的 Docket 对象来应用配置。您必须花点时间，因为需要进行一些配置才能使其正常工作，更不用说根据您的应用程序需求进行扩展了。

 @Bean
    public Docket documentation() {
        return new Docket()
          .select()
            .apis(RequestHandlerSelectors.any())
            .paths(regex("/api/.*"))
            .build()
          .pathMapping("/")
          .apiInfo(metadata());
    }

您可能已经知道，您可以添加注释，例如可能的 HTTP 响应代码等，以及许多其他功能。确实非常有前途。

@ApiOperation(value = "doStuff", nickname = "doStuff", response = DoStuffResult.class)
@Responses({
    @ApiResponse(code =  404, message ="Not found", response = GenericError.class),
    @ApiResponse(code =  400, message ="Invalid input", response = GenericError.class)
})
@RequestMapping(method = RequestMethod.GET, produces = "application/json")
public ResponseEntity<?> doStuff(@RequestBody DoStuffCommand command) {
    // Stuff
}

这是best example我可以在网上找到，非常简短且客观。