【发布时间】:2015-07-02 04:39:35
【问题描述】:
我正在尝试一个小应用程序来学习带有 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>
Application.java
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 是 https://spring.io/guides/gs/rest-service/ 中提供的 spring-restful-demo 中的普通 pojo
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;
}
}
索引.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...*/
你能看出我哪里做错了吗? 也许我错过了什么?
【问题讨论】:
-
我猜你用的是spring boot app,你是不是加了swagger的拦截器
-
@Pulkit:不,我没有使用任何拦截器。我尝试将 swagger-ui 添加到 spring 网站上的 spring RESTful 教程中。
标签: java maven spring-mvc swagger swagger-ui