无法访问SwaggerUI index.html页面,但可以打开api-docs(Spring - Boot)

时间:2015-07-02 04:39:35

标签: java maven spring-mvc swagger swagger-ui

我正在尝试使用swagger UI学习弹簧启动的小应用程序。当我运行程序时,我可以打开显示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和所有程序代码的截图

enter image description here

的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.javahttps://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;
 }
}

的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...*/

你能看到我做错了吗? 也许我错过了什么?

1 个答案:

答案 0 :(得分:3)

final ImageView iv = new ImageView(context); iv.setImageResource(R.drawable.green_apple); rl.addView(iv); iv.getViewTreeObserver().addOnPreDrawListener(new OnPreDrawListener() { @Override public boolean onPreDraw() { iv.getViewTreeObserver().removeOnPreDrawListener(this); int w = (int) (iv.getWidth() * 0.3); int h = (int) (iv.getHeight() * 0.3); RelativeLayout.LayoutParams rlp = new RelativeLayout.LayoutParams(w, h); iv.setLayoutParams(rlp); return true; } }); 类中删除所有注释,并将其替换为spring-boot 1.2及更高版本中的Application以及@SpringBootApplication@EnableAutoConfiguration的组合,以用于以下启动版本1.2.x.特别是删除@ComponentScan注释,因为它干扰了资源的弹簧启动自动配置,即提供swagger-ui的那个。

另外,你的swagger-springmvc依赖非常过时你应该至少使用1.0.2。您是否考虑过使用springfox进行移动?它是下一代的swagger-springmvc,它也支持swagger 2.0。