springMVC整合swagger(亲自试验完全可用)

swagger是什么:

[plain] view plaincopyprint?

Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。本文简单介绍了在项目中集成swagger的方法和一些常见问题。如果想深入分析项目源码，了解更多内容，见参考资料。
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。

将swagger集成到springmvc项目中去:

首先添加swagger依赖,作者用的maven管理：

[html] view plaincopyprint?

<dependency>
<groupId>com.mangofactory</groupId>
<artifactId>swagger-springmvc</artifactId>
<version>1.0.2</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
<version>2.5.1</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.5.1</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<version>2.5.1</version>
</dependency>

创建自定义swagger初始化配置文件：

[java] view plaincopyprint?

package com.yrok.swagger;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import com.mangofactory.swagger.configuration.SpringSwaggerConfig;
import com.mangofactory.swagger.models.dto.ApiInfo;
import com.mangofactory.swagger.plugin.EnableSwagger;
import com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin;
@EnableSwagger
public class SwaggerConfig {
private SpringSwaggerConfig springSwaggerConfig;
/**
* Required to autowire SpringSwaggerConfig
*/
@Autowired
public void setSpringSwaggerConfig(SpringSwaggerConfig springSwaggerConfig)
{
this.springSwaggerConfig = springSwaggerConfig;
}
/**
* Every SwaggerSpringMvcPlugin bean is picked up by the swagger-mvc
* framework - allowing for multiple swagger groups i.e. same code base
* multiple swagger resource listings.
*/
@Bean
public SwaggerSpringMvcPlugin customImplementation()
{
return new SwaggerSpringMvcPlugin(this.springSwaggerConfig)
.apiInfo(apiInfo())
.includePatterns(".*?");
}
private ApiInfo apiInfo()
{
ApiInfo apiInfo = new ApiInfo(
"springmvc搭建swagger",
"spring-API swagger测试",
"My Apps API terms of service",
"534560449@qq.com",
"web app",
"My Apps API License URL");
return apiInfo;
}
}

将swagger配置类及依赖SpringSwaggerConfig加载到spring容器中：

[html] view plaincopyprint?

<mvc:annotation-driven />
<bean class="com.mangofactory.swagger.configuration.SpringSwaggerConfig" />
<bean class="com.yrok.swagger.SwaggerConfig" />

配置相关controller的api：

[java] view plaincopyprint?

package com.yrok.controller;
import javax.annotation.Resource;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
import com.wordnik.swagger.annotations.Api;
import com.wordnik.swagger.annotations.ApiOperation;
import com.wordnik.swagger.annotations.ApiParam;
import com.yrok.entity.User;
import com.yrok.service.UserService;
@Api(value="user")
@Controller
@RequestMapping(value="/user")
public class UserController {
@Resource
UserService userService;
@RequestMapping(value = "/getUser")
@ResponseBody
@ApiOperation(value="根据ID获取用户信息",httpMethod="GET",notes="get user by id",response=User.class)
public User getUser(@ApiParam(required=true,value="用户ID",name="userId")@RequestParam(value="userId")Integer userId) {
return userService.getUserByID(userId);
}
}

和Swagger UI的集成：

在GitHub上将swaggerui下载，地址:https://github.com/swagger-api/swagger-ui

解压后将dist文件夹中所有的文件拷贝到webapp/swagger这里的swagger是作者自定义的你可以写为自己创建的目录。

修改index.html中的 http://petstore.swagger.wordnik.com/v2/swagger.json修改为自己项目路径+api-docs,例如：

http://localhost:8080/SSMSwagger/api-docs：SSMSwagger为项目名称。

在spring-mvc.xml中过滤掉swagger-ui的文件：

[html] view plaincopyprint?

<mvc:resources mapping="/swagger/**" location="/swagger/" />

到这里基本完成了springmvc和swagger的整合，下面是测试结果：

在浏览器中访问:http://localhost:8080/SSMSwagger/swagger/index.html#/user/getUser

到此，本篇文章已经结束，下面分享其他资料和参考：

参考地址：
官网：http://swagger.io/
GitHub：
swagger-springmvc:https://github.com/martypitt/swagger-springmvc
swagger-ui:https://github.com/swagger-api/swagger-ui
swagger-core:https://github.com/swagger-api/swagger-core
swagger-spec：https://github.com/swagger-api/swagger-spec

springMVC整合swagger(亲自试验完全可用)相关推荐

springmvc整合swagger 与常用注解说明
Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件. Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使 ...
六：Dubbo与Zookeeper、SpringMvc整合和使用
DUBBO与ZOOKEEPER.SPRINGMVC整合和使用互联网的发展,网站应用的规模不断扩大,常规的垂直应用架构已无法应对,分布式服务架构以及流动计算架构势在必行,Dubbo是一个分布式服务框架 ...
03、Swagger2和Springmvc整合详细记录（爬坑记录）
时间内容备注 2018年6月18日基本使用 spirngmvc整合swagger2 开始之前这个系列博文基本是,在项目的使用中一些模块的内容记录,但是后期逐渐优化,不单单是整合内容. swagg ...
Spring整合swagger
最近主要负责接口开发,每次都用以前用过的postman,发现配置参数这些比较麻烦,然后有人推荐用swagger.于是尝试将swagger整合到项目中. 配置 //pomx.xml 添加依赖 <d ...
SSM整合Swagger
现在后端比较流行的框架是spring boot.使用spring boot集成swagger也非常方便.这里我们先来看看ssm整合Swagger. 导入依赖 spring和swagger之间存在版本问 ...
SpringMVC整合Swagger2
SpringMVC整合Swagger2 前言 POM引入 Swagger配置类 spring-mvc.xml设置如果有在web.xml里配置拦截器测试类准备就绪注意事项爬坑经历参考文章前 ...
闲置服务器装win10系统,9年前的电脑装Win 10会怎么样？小编亲自试验
原标题:9年前的电脑装Win 10会怎么样?小编亲自试验最近家里装了宽带,以前有一台老式电脑闲置,于是想拿来装一下系统给家里父母用来看看电视什么的,原本是Win XP的系统,但是一键还原之后突然就蓝 ...
SpringMVC整合SwaggerUI
SpringMVC整合SwaggerUI 文章目录 SpringMVC整合SwaggerUI 概念介绍相关资源下载编写整合代码 index.html文件修改 maven中引入依赖 springmv ...
六、springboot整合swagger
六.springboot整合swagger 简介 swagger 提供最强大,最易用的工具,以充分利用OpenAPI规范. 官网 : https://swagger.io/ 准备工作 pom.xml ...

springMVC整合swagger(亲自试验完全可用)

springMVC整合swagger(亲自试验完全可用)相关推荐

最新文章

热门文章