我可以從現有的Java代碼中獲取Swagger文檔嗎？

Question

我絕對是Swagger的新手，我有以下疑問：

我知道一般來說，我必須先編寫Swagger文檔，然后再編寫REST API並使用該文檔來創建我的API（我知道從Swagger編輯器中，我也可以自動生成我的API服務器）。

我的問題是以下一個：

我正在開發實現REST API的Java應用程序（Spring Boot應用程序）。 我想使用Swagger創建我的API文檔。

存在自動執行的方法嗎？ 從我的Java代碼到Swagger yaml文件？ 例如，以某種工具可以解析的方式注釋我的Java代碼？

Answer 1

是的，有一個工具可以輕松地從您已經編寫的代碼中生成詳盡的文檔。

Spring Appllication包含的內容將創建文檔https://springfox.github.io/springfox/docs/current/

我認為這是正確的方法。 不要創建文檔並生成代碼，而要生成文檔。 這也是創建Javadoc的方式。

Answer 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#/