spring-boot - 无法通过 Spring Boot 获得 Swagger UI

Question

我正在关注 http://raibledesigns.com/rd/entry/documenting_your_spring_api_with 上的文章.

一切正常，但无法集成 Swagger UI。

http://localhost:8080/docs/index.html  

导致/error 重定向。

Answer 1

我知道这是一个老问题，但也许这会对将来遇到类似问题的人有所帮助。

我遵循了与你提到的类似的教程，我让它毫无问题地工作。几周前，我发布了自己的文档，介绍如何在 Spring Boot 项目中使用 UI 设置 Swagger。也许它会帮助你，因为它更短而且更新。

添加 Maven 依赖项

把这些放在你的 pom.xml 中:

<dependency>
 <groupId>com.mangofactory</groupId>
 <artifactId>swagger-springmvc</artifactId>
 <version>1.0.2</version>
 <type>jar</type>
</dependency>

添加 Swagger UI

下载 Swagger UI来自 github。复制 dist文件夹到您的 webapp目录并重命名 dist至 swagger (或任何你喜欢的名字)。

打开复制目录中的 index.html 文件并更改第一个 javascript 函数中的 url，使其指向 /api-docs endpoint :

var url = window.location.search.match(/url=([^&]+)/);
  if (url && url.length > 1) {
  url = decodeURIComponent(url[1]);
  } else {
  url = "/project-name/api-docs";
 }

配置 Swagger

创建一个 SwaggerConfig.java 类并在那里配置 swagger:

@Configuration
@EnableSwagger
@EnableAutoConfiguration
public class SwaggerConfig {
  private SpringSwaggerConfig springSwaggerConfig;
  @Autowired
  public void setSpringSwaggerConfig(SpringSwaggerConfig springSwaggerConfig) {
    this.springSwaggerConfig = springSwaggerConfig;
  }
  @Bean
  public SwaggerSpringMvcPlugin customImplementation() {
    return new SwaggerSpringMvcPlugin(this.springSwaggerConfig)
    // Root level documentation
    .apiInfo(new ApiInfo("Swagger-demo JSON API", "This service provides a JSON representation the service API", null, null, null, null))
    .useDefaultResponseMessages(false)
    // Map the specific URL patterns into Swagger
    .includePatterns("/greeting.*");
  }
}

你的招摇现在应该开始运行了。尝试访问 /project-name/swagger/index.html .