我可以从现有的 Java 代码中获取 Swagger 文档吗？答案

【问题标题】：Can I obtain the Swagger documentation from pre existing Java code?我可以从现有的 Java 代码中获取 Swagger 文档吗？
【发布时间】：2017-05-28 21:47:29
【问题描述】：

我是 Swagger 的新手，我有以下疑问：

我知道通常我必须先创建 Swagger 文档，然后再编写我的 REST API 并使用此文档来创建我的 API（我知道通过 Swagger 编辑器我也可以自动生成我的 API 服务器）。

我的问题如下：

我正在开发一个实现我的 REST API 的 Java 应用程序（一个 Spring Boot 应用程序）。我想使用 Swagger 创建我的 API 文档。

存在自动执行此操作的方法吗？从我的 Java 代码到 Swagger yaml 文件？例如，以某种工具可以解析的方式注释我的 Java 代码？

【问题讨论】：

标签： java rest swagger swagger-ui swagger-2.0

【解决方案1】：

是的，有一个工具可以轻松地从您已经编写的代码生成 swagger 文档。

这包含在 Spring 应用程序中将创建文档 https://springfox.github.io/springfox/docs/current/

在我看来，这是正确的方法。不要创建文档并生成代码，而是生成文档。这也是 Javadoc 的创建方式。

【讨论】：

【解决方案2】：

您不需要特别注释任何内容。

创建一个类似如下的类，用Swagger访问API：

@Configuration
@EnableSwagger2
public class SwaggerConfig{

  @Bean
  public Docket api(){

    return new Docket(DocumentationType.SWAGGER_2).select().apis(
        RequestHandlerSelectors.basePackage("com.yourcompany.restcode")).paths(PathSelectors.any()).build();
  }
}

然后使用以下内容访问 API 文档：

localhost:8080/swagger-ui.html#/

【讨论】：

但是这个配置是针对 Spring MVC 还是针对 Spring Boot 的？
Spring Boot 配置。