[英]Cannot access SwaggerUI index.html page, but can open api-docs (Spring - Boot)
我正在嘗試一個小應用程序,以使用swagger UI學習Spring Boot。 當我運行程序時,我可以打開顯示json輸出的http://localhost:8080/api-docs
。 但是當我訪問http://localhost:8080/swagger/index.html
,它顯示了Whitelabel錯誤頁面。
我遵循的步驟:
1-從GitHub中的swagger-ui項目復制了“ dist”文件夾。
2-將“ dist”重命名為“ swagger”,並將其放入src/main/public
3-將index.html中的路徑更改為“ / api-docs”。
下面是EclipseLuna IDE和所有程序代碼的屏幕截圖,
pom.xml
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.rajkishan.learnSpring</groupId>
<artifactId>RestfulWithSpring</artifactId>
<version>1.0.0</version>
<packaging>war</packaging>
<name>LearnRESTfulSpring</name>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.1.12.RELEASE</version>
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<java.version>1.8</java.version>
<start-class>com.rajkishan.Application</start-class>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j</artifactId>
<exclusions>
<exclusion>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.mangofactory</groupId>
<artifactId>swagger-springmvc</artifactId>
<version>0.8.8</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
應用程序
package com.rajkishan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
/**
* Spring Boot Starter Class
*
*/
@Configuration
@EnableAutoConfiguration
@ComponentScan
@EnableWebMvc
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
Greeting.java
是正常的pojo,如https://spring.io/guides/gs/rest-service/中提供的spring-restful-demo
GreetingController.java
package com.rajkishan;
import java.util.concurrent.atomic.AtomicLong;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class GreetingController {
private static final String template = "Hello, %s!";
private final AtomicLong counter = new AtomicLong();
@RequestMapping(value = "/greeting", method = RequestMethod.GET, produces = "application/json")
public Greeting greeting(@RequestParam (value = "name", defaultValue = "World") String name){
return new Greeting(counter.incrementAndGet(), String.format(template, name));
}
}
SwaggerConfig.java
package com.rajkishan;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import com.mangofactory.swagger.configuration.SpringSwaggerConfig;
import com.mangofactory.swagger.plugin.EnableSwagger;
import com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin;
import com.wordnik.swagger.model.ApiInfo;
@Configuration
@EnableSwagger
public class SwaggerConfig {
private SpringSwaggerConfig swaggerConfig;
@Autowired
public void setSpringSwaggerConfig(SpringSwaggerConfig swaggerConfig){
this.swaggerConfig = swaggerConfig;
}
@Bean
public SwaggerSpringMvcPlugin customSwaggerPlugin(){
return new SwaggerSpringMvcPlugin(this.swaggerConfig).apiInfo(apiInfo())
.includePatterns("/greeting/.*");
}
private ApiInfo apiInfo(){
ApiInfo apiInfo = new ApiInfo("My Spring Application",
"Learning Spring Restful", "termsOfServiceUrl", "contact", "license", "licenseUrl");
return apiInfo;
}
}
Index.html
$(function() {
var url = window.location.search.match(/url=([^&]+)/);
if (url && url.length > 1) {
url = decodeURIComponent(url[1]);
} else {
url = "/api-docs"
}
/*Rest of the Code Follows...*/
你能看出我做錯了什么嗎? 也許我錯過了什么?
在您的Application
類中,刪除所有注釋,並在spring-boot 1.2及更高版本@EnableAutoConfiguration
其替換為@SpringBootApplication
,並將@EnableAutoConfiguration
和@ComponentScan
組合在一起以用於低於@EnableAutoConfiguration
的啟動版本。 特別要刪除@EnableWebMvc
批注,因為它會干擾資源的Spring Boot自動配置,即服務於swagger-ui的配置。
另外,您的swagger-springmvc依賴關系已經過時,您應至少使用1.0.2。 在相關說明中,您是否考慮過使用springfox移動? 它是swagger-springmvc的下一代產品,還支持swagger 2.0。
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.