springmvc 整合 swagger 自动生成 web ap

作者: 码农梦醒 | 来源:发表于2016-08-16 18:54 被阅读4706次

springmvc 整合 swagger 自动生成 web ap
[Swagger] Spring MVC 组件配置之 Swag
springmvc+swagger2整合
Spring系列整合Swagger
.net core API 项目中的Swagger的简单使用
swagger简介
Swagger整合SpringMvc生成Restful接口文档
springmvc和swagger整合
springboot2（1）-Swagger2集成
Swagger代码实战

前提条件: 已引入spring以及spring mvc的包,并做好了相关配置，能够正常运行

一. pom中引入swagger相关的依赖

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.5.0</version>
    <exclusions>
        <exclusion>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
        </exclusion>
        <exclusion>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
        </exclusion>
        <exclusion>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aop</artifactId>
        </exclusion>
        <exclusion>
            <groupId>org.springframework</groupId>
            <artifactId>spring-beans</artifactId>
        </exclusion>
        <exclusion>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.5.0</version>
</dependency>
<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-annotations</artifactId>
    <version>1.5.9</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-staticdocs</artifactId>
    <version>2.5.0</version>
    <exclusions>
        <exclusion>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
        </exclusion>
        <exclusion>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
        </exclusion>
        <exclusion>
            <groupId>com.fasterxml.jackson.dataformat</groupId>
            <artifactId>jackson-dataformat-yaml</artifactId>
        </exclusion>
        <exclusion>
            <groupId>joda-time</groupId>
            <artifactId>joda-time</artifactId>
        </exclusion>
        <exclusion>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
        </exclusion>
        <exclusion>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
        </exclusion>
        <exclusion>
            <groupId>com.fasterxml.jackson.datatype</groupId>
            <artifactId>jackson-datatype-joda</artifactId>
        </exclusion>
    </exclusions>
</dependency>

二. web.xml中启用web容器的default servlet，将静态资源交由web容器处理(这里主要指html文件)

<!-- 让容器来处理静态文件,防止spring mvc去处理(spring mvc处理静态文件的能力不如容器本身) -->
<servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.js</url-pattern>
</servlet-mapping>
<servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.css</url-pattern>
</servlet-mapping>
<servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.jpg</url-pattern>
</servlet-mapping>
<servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.png</url-pattern>
</servlet-mapping>
<servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.gif</url-pattern>
</servlet-mapping>
<servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.html</url-pattern>
</servlet-mapping>
<servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.wof</url-pattern>
</servlet-mapping>

四. 创建ApplicationSwaggerConfig类

package apidoc;

import org.springframework.context.annotation.Bean;

import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * 
 * @author pan
 *
 */
@EnableSwagger2
public class ApplicationSwaggerConfig {

    @Bean
    public Docket addUserDocket() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2);
        Contact contact = new Contact("潘志勇", "", "zhiyong.pan@comix.com.cn");
        ApiInfo apiInfo = new ApiInfo("进销存管理系统", "WEB API文档", "V0.0.1", "", contact, "", "");
        docket.apiInfo(apiInfo);
        return docket;
    }
}

三.spring mvc配置文件中加入如下配置

<!-- Include a swagger configuration -->
    <bean name="applicationSwaggerConfig" class="apidoc.ApplicationSwaggerConfig" />
    <mvc:default-servlet-handler/>

四. API编写测试

package com.qc.invoicing.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
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.ResponseBody;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiModelProperty;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;

@Controller
@RequestMapping(value = "/test", produces = { "application/json;charset=utf-8" })
@Api(value = "/test", description = "测试Contrler")
public class TestController {

    @RequestMapping(value = "/restStyle/{id}", method = RequestMethod.GET)
    @ApiOperation(notes = "/restStyle", httpMethod = "GET", value = "rest风格方法")
    @ApiResponses(value = { @ApiResponse(code = 200, message = "正常操作", response = StringAPIResponse.class) })
    @ResponseBody
    public StringAPIResponse restStyle(@ApiParam(required = true, value = "主键") @PathVariable(value = "id") long id) {
        System.err.println(id);
        StringAPIResponse apiResponse = new StringAPIResponse();
        apiResponse.setMsg("操作成功");
        apiResponse.setData("你好");
        return apiResponse;
    }

    @RequestMapping(value = "/getStyle", method = RequestMethod.GET)
    @ApiOperation(notes = "/getStyle", httpMethod = "GET", value = "get风格方法")
    @ApiResponses(value = { @ApiResponse(code = 200, message = "正常操作", response = StringAPIResponse.class) })
    @ResponseBody
    public StringAPIResponse getStyle(@ApiParam(required = true, value = "主键") @RequestParam("id") long id) {
        System.err.println(id);
        StringAPIResponse apiResponse = new StringAPIResponse();
        apiResponse.setMsg("操作成功");
        apiResponse.setData("你好");
        return apiResponse;
    }

    @RequestMapping(value = "/postStyle", method = RequestMethod.POST)
    @ApiOperation(notes = "/postStyle", httpMethod = "POST", value = "post风格方法")
    @ApiResponses(value = { @ApiResponse(code = 200, message = "正常操作", response = StringAPIResponse.class) })
    @ResponseBody
    public StringAPIResponse postStyle(@ApiParam(required = true, value = "简单数据") @RequestBody SimpleData data) {
        System.err.println(data.getName());
        StringAPIResponse apiResponse = new StringAPIResponse();
        apiResponse.setMsg("操作成功");
        apiResponse.setData("你好");
        return apiResponse;
    }

    @RequestMapping(value = "/traditionStyle", method = RequestMethod.GET, produces = { "application/xml;charset=utf-8" })
    @ApiOperation(notes = "转入页面:/WEB-INF/jsp/test.jsp", httpMethod = "GET", value = "传统风格方法")
    @ApiResponses(value = { @ApiResponse(code = 200, message = "正常操作", response = StringAPIResponse.class) })
    public String traditionStyle() {
        return "/test";
    }

}

class SimpleData {

    @ApiModelProperty(value = "主键", hidden = false)
    private long id;

    @ApiModelProperty(value = "名称", required = true)
    private String name;

    @ApiModelProperty(value = "年龄")
    private int age;

    public long getId() {
        return id;
    }

    public void setId(long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

}

abstract class APIResponse<T> {

    @ApiModelProperty(value = "操作是否成功")
    private boolean optSuc = true;

    @ApiModelProperty(value = "操作失败时的提示信息")
    private String msg;

    @ApiModelProperty(value = "返回结果")
    private T data;

    public boolean isOptSuc() {
        return optSuc;
    }

    public void setOptSuc(boolean optSuc) {
        this.optSuc = optSuc;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }
}

class StringAPIResponse extends APIResponse<String> {

}

五. 启动jetty(如果是使用maven命令运行web项目，请使用jetty作为web容器，否则无法访问swagger)

mvn jetty:run

//访问地址:
http://ip:端口/项目名/swagger-ui.html#/
例如：
http://localhost:9080/test-project/swagger-ui.html

结果：

Paste_Image.png

springmvc 整合 swagger 自动生成 web ap
前提条件: 已引入spring以及spring mvc的包,并做好了相关配置，能够正常运行一. pom中引入sw...
[Swagger] Spring MVC 组件配置之 Swag
Spring MVC 组件配置之 Swagger整合（自定义样式调整）（springmvc-swagger）开...
springmvc+swagger2整合
springmvc+swagger2整合整合的过程中遇到了一些问题，特此记录。问题一：springmvc中使用...
Spring系列整合Swagger
SpringMvc整合Swagger（spring版本在4.1.8以上，深深的痛） 1.先搭建好springmvc...
.net core API 项目中的Swagger的简单使用
1.什么是Swagger Swagger可以根据你的项目代码，自动生成一套完整的，可视化，可供调试的web服务，可...
swagger简介
swagger是一个工具，用于自动生成web网站对外提供的服务接口文档，并且以web页面的形式进行展示。那么我们...
Swagger整合SpringMvc生成Restful接口文档
关于swagger和springmvc整合的文章，大家可以看看我的csdn博客blog.csdn.net/zjx2...
springmvc和swagger整合
描述 Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。...
springboot2（1）-Swagger2集成
Swagger2 的作用随项目自动生成强大RESTfulAPI文档，减少工作量API文档与代码整合在一起，便于同...
Swagger代码实战
什么是Swagger Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。Swagger...