地址链接:https://blog.csdn.net/lx1309244704/article/details/81808788

swagger是一款高效易用的嵌入式文档插件,同时支持在线测试接口,快速生成客户端代码。spring-boot-starter-swagger通过spring-boot方式配置的swagger实现。完美并且完整的支持swagger-spring的所有配置项,配置及其简单,容易上手。支持api分组配置,通过正则表达式方式分组。支持分环境配置,你可以很容易让你的项目api文档在开发环境,测试环境。

依赖包

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>

model中常用的注解:@ApiModel 注解类名,@ApiModelProperty 注解方法或者参数名

UserModel

package com.swagger.model;

import java.io.Serializable;

import io.swagger.annotations.ApiModelProperty;

/**
* <p>
* 角色
* </p>
*
* @author lixin(1309244704@qq.com)
* @since 2018-08-03
*/
public class UserModel implements Serializable {

private static final long serialVersionUID = 1L;

@ApiModelProperty(value = "id", required = false, position = 1, example = "10001")
private Long userId;

@ApiModelProperty(value = "编号", required = false, position = 1, example = "10001")
private String userCode;

@ApiModelProperty(value = "名称", required = false, position = 1, example = "张三")
private String userName;

public UserModel() {

}

public UserModel(long userId, String userCode,String userName) {
this.setUserId(userId);
this.setUserCode(userCode);
this.setUserName(userName);
}

public Long getUserId() {
return userId;
}

public void setUserId(Long userId) {
this.userId = userId;
}

public String getUserCode() {
return userCode;
}

public void setUserCode(String userCode) {
this.userCode = userCode;
}

public String getUserName() {
return userName;
}

public void setUserName(String userName) {
this.userName = userName;
}

@Override
public String toString() {
return "UserModel [userId=" + userId + ", userCode=" + userCode + ", userName=" + userName + "]";
}

}
控制器中常用的注解: @Api 注解控制器显示的标识,有tags和description可以配置控制器显示的标识;@ApiOperation 用来注解控制器方法显示的标识; @ApiParam 用来注解控制器方法参数的名字,控制器方法在文档中需要显示的默认值

UserController

package com.swagger.web.controller;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
import org.springframework.stereotype.Controller;
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 com.swagger.api.IUserService;
import com.swagger.model.UserModel;
import com.swagger.util.ApiConst;
import com.swagger.util.ResultEntity;

import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;

/**
* <p>
* 角色前端控制器
* </p>
*
* @author lixin(1309244704@qq.com)
* @since 2018-08-03
*/
@Controller
@RequestMapping("/user")
public class UserController {

private @Autowired IUserService userService;

@ApiOperation(value = "添加")
@RequestMapping(value = "/addUser", method = RequestMethod.POST, produces = {
MediaType.APPLICATION_JSON_UTF8_VALUE })
public @ResponseBody ResultEntity<String> addUser(
@ApiParam(value = "id", required = true) @RequestParam(value = "userId", required = true) Long userId,
@ApiParam(value = "角色编号", required = true) @RequestParam(value = "userCode", required = true) String userCode,
@ApiParam(value = "角色名称", required = true) @RequestParam(value = "userName", required = true) String userName) {
try {
UserModel user = new UserModel();
user.setUserId(userId);
user.setUserCode(userCode);
user.setUserName(userName);
userService.addUser(user);
return new ResultEntity<String>(ApiConst.CODE_SUCC, ApiConst.DESC_SUCC);
} catch (Exception e) {
e.getStackTrace();
}
return new ResultEntity<String>(ApiConst.CODE_FAIL, ApiConst.DESC_FAIL);
}
@ApiOperation(value = "查询")
@RequestMapping(value = "/getUser", method = RequestMethod.POST, produces = {
MediaType.APPLICATION_JSON_UTF8_VALUE })
public @ResponseBody ResultEntity<List<UserModel>> getUser() {
try {
List<UserModel> list = userService.getUser();
return new ResultEntity<List<UserModel>>(ApiConst.CODE_SUCC, ApiConst.DESC_SUCC,list);
} catch (Exception e) {
e.getStackTrace();
}
return new ResultEntity<List<UserModel>>(ApiConst.CODE_FAIL, ApiConst.DESC_FAIL);
}

}
swaggerConfig配置

@Configuration
@EnableSwagger2
public class SwaggerConfig {

@Bean
public Docket customDocket() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.swagger.web.controller"))
.paths(PathSelectors.any())
.build();
}

private ApiInfo apiInfo() {
return new ApiInfoBuilder()
// .title("")
.description("测试接口Api")
.termsOfServiceUrl("127.0.0.1")
.version("1.0")
.build();
}
然后我们在看看我们自己的Ui,虽然和v2版的差不多,但是里面有些不同

这是我们Ui的静态资源

实际应用中,我们会有在项目服务启动的时候就去加载一些数据或做一些事情这样的需求。 
为了解决这样的问题,Spring Boot 为我们提供了一个方法,通过实现接口 CommandLineRunner 来实现。

SwaggerCommandLineRunner

package com.swagger.config;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.CommandLineRunner;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

/**
* @ClassName: SwaggerCommandLineRunner
* @Description: TODO(启动加载swagger)
* @author lixin
* @date 2018年8月17日 下午4:17:32
*
*/
@Component
@Order(value = 1)
public class SwaggerCommandLineRunner implements CommandLineRunner {

private static Logger logger = LoggerFactory.getLogger(SwaggerCommandLineRunner.class);

@Override
public void run(String... args) throws Exception {
logger.debug(">>>>>>>>>>>>>>服务启动加载:swagger初始化<<<<<<<<<<<<<");
}

}

OK,下面来说一说SpringBoot 的拦截器配置,这里的拦截器配置分为  SpringBoot 1.X版本和 SpringBoot 2.X版本:

SpringBoot 1.X用的是 继承 WebMvcConfigurerAdapter类;

在SpringBoot 2.X中,WebMvcConfigurerAdapter这个类已经过时了,可以用继承WebMvcConfigurationSupport,也可以实现 WebMvcConfigurer这个接口;在使用这个SpringBoot 2.X配置拦截器后,发现静态资源居然也被拦截了,这里就需要我们在过滤条件时,放开静态资源路径,我使用的是实现 WebMvcConfigurer这个接口。下面是拦截器的配置:

WebInterceptor

package com.swagger.config;

import java.io.PrintWriter;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import net.sf.json.JSONObject;

/**
* @ClassName: WebInterceptor
* @Description: TODO()
* @author lixin(1309244704@qq.com)
* @date 2018年8月18日 下午2:58:42
* @version V1.0
*/
public class WebInterceptor implements HandlerInterceptor {

@Override
public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
System.out.println("============== request before ==============");
httpServletResponse.addHeader("Access-Control-Allow-Origin", "*");
httpServletResponse.addHeader("Access-Control-Allow-Methods", "*");
httpServletResponse.addHeader("Access-Control-Max-Age", "1800");
httpServletResponse.addHeader("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept, token");
httpServletResponse.addHeader("Access-Control-Allow-Credentials", "true");
httpServletResponse.setContentType("application/json;charset=UTF-8");
httpServletResponse.setHeader("Cache-Control", "no-cache");
String token = httpServletRequest.getHeader("token");
if(null != token){
return true;
}
PrintWriter out = httpServletResponse.getWriter();
JSONObject res = new JSONObject();
res.put("success","false");
res.put("msg","登录信息失效,请重新登录!");
out.append(res.toString());
out.flush();
return false;
}

@Override
public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
System.out.println("============== request ==============");
}

@Override
public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
System.out.println("============== request completion ==============");
}
}
WebMvcConfig

package com.swagger.config;

import java.util.Arrays;

import javax.servlet.MultipartConfigElement;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.web.servlet.MultipartConfigFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
* @ClassName: WebMvcConfig
* @Description: TODO()
* @author lixin(1309244704@qq.com)
* @date 2018年8月18日 下午2:58:52
* @version V1.0
*/
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

private static Logger logger = LoggerFactory.getLogger(SwaggerCommandLineRunner.class);

/* (非 Javadoc)
* <p>Title: addCorsMappings</p>
* <p>Description: 跨域</p>
* @param registry
* @see org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter#addCorsMappings(org.springframework.web.servlet.config.annotation.CorsRegistry)
*/
@Override
public void addCorsMappings(CorsRegistry registry) {
registry.addMapping("/**")
.allowedOrigins("*")
.allowCredentials(true)
.allowedMethods("GET", "POST", "DELETE", "PUT")
.maxAge(3600);
}

public void addInterceptors(InterceptorRegistry registry) {
// registry.addInterceptor(new WebInterceptor());
registry.addInterceptor(new WebInterceptor()).excludePathPatterns(Arrays.asList("/static/**","/api/**")); //放开静态资源拦截
logger.debug(">>>>>>>>>>>>>> 拦截器注册完毕<<<<<<<<<<<<<");
}
/** 上传附件容量限制 */
@Bean
public MultipartConfigElement multipartConfigElement() {
MultipartConfigFactory factory = new MultipartConfigFactory();
factory.setMaxFileSize("102400KB");
factory.setMaxRequestSize("112400KB");
return factory.createMultipartConfig();
}
}
OK到这里,我们的配置也就结束了。

参考文档:https://docs.spring.io/spring-boot/docs/2.0.4.RELEASE/reference/htmlsingle/

Github下载路径:测试项目demo

访问的路径是:http://localhost:8001/api/index.html,下面是我做测试的图

不填token

填入token

---------------------
作者:尔笑惹千愁
来源:CSDN
原文:https://blog.csdn.net/lx1309244704/article/details/81808788
版权声明:本文为博主原创文章,转载请附上博文链接!

项目集成swagger【转载】的更多相关文章

  1. 项目集成swagger,并暴露指定端点给swagger

    项目集成swagger 一:思考: 1.swagger解决了我们什么问题? 传统开发中,我们在开发完成一个接口后,为了测试我们的接口,我们通常会编写单元测试,以测试我们的接口的可用性,或者用postm ...

  2. Maven + SpringMVC项目集成Swagger

    Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方法,参数和模型紧密集成到服 ...

  3. 【Spring Boot&&Spring Cloud系列】Spring Boot项目集成Swagger UI

    前言 Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方法,参数和模型紧密集 ...

  4. MVC项目集成swagger

    1.创建WebAPI项目解决方案 2.使用nuget引入Swashbuckle包 引入Swashbuckle包后App_Start文件夹下会多出一个SwaggerConfig文件 3.添加接口注释 项 ...

  5. SpringBoot项目集成swagger报NumberFormatException: For input string: ""

    java.lang.NumberFormatException: For input string: "" at java.lang.NumberFormatException.f ...

  6. SpringBoot+SpringCloud+vue+Element开发项目——集成Swagger文档

    在pom.xml文件中添加Maven依赖 <!--swagger--> <dependency> <groupId>io.springfox</groupId ...

  7. SpringBoot项目集成Swagger启动报错: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is

    使用的Swagger版本是2.9.2.knife4j版本是2.0.4. SpringBoot 版本是2.6.2将SpringBoot版本回退到2.5.6就可以正常启动

  8. Spring_Boot项目集成Swagger填坑

    事情是这样的: 最近疫情在家里闲的无聊 看了看Swagger-2 在练习的过程出现了错误 写个帖子 希望跟我有同样问题的朋友可以避雷. 下面进入正题: 编辑 我使用的swagger-2版本是2.9.4 ...

  9. springboot快速集成swagger

    今天技术总监说:小明,我们本次3.0改造,使用swagger2.0作为前后端分离的接口规范,它可以一键生成前后端的API,一劳永逸--小明:??? Spring Boot 框架是目前非常流行的微服务框 ...

随机推荐

  1. Django学习笔记之视图高级-HTTP请求与响应

    Django限制请求method 常用的请求method GET请求 GET请求一般用来向服务器索取数据,但不会向服务器提交数据,不会对服务器的状态进行更改.比如向服务器获取某篇文章的详情. POST ...

  2. maven依赖冲突

    https://blog.csdn.net/noaman_wgs/article/details/81137893

  3. ActiveMQ (二)—发布订阅模式

    ActiveMQ的另一种模式就SUB/HUB即发布订阅模式,是SUB/hub就是一拖N的USB分线器的意思.意思就是一个来源分到N个出口.还是上节的例子,当一个订单产生后,后台N个系统需要联动,但有一 ...

  4. delphi 多线程之System.TMonitor

    三天不写代码就手生! 把测试代码记录下来. unit Unit1; interface uses Winapi.Windows, Winapi.Messages, System.SysUtils, S ...

  5. M25P16中文版

    转载:https://blog.csdn.net/weiweiliulu/article/details/23666717 1.M25P16概述     M25P16是一款带有先进写保护机制和高速SP ...

  6. Jquery 扩展方法实现原理

    JSONP原理 首先:JSON和JSONP是不一样的概念. JSON是一种数据交换格式,而JSONP是非正式传输协议. 该协议的一个要点就是允许用户传递一个callback参数给服务端,然后服务端返回 ...

  7. Elasticsearch-6.7.0系列(二)ES集群安装与验证

    准备3台centos7机器/虚拟机,每台都安装上elasticsearch6.7.0 ,安装过程参考我的另一篇博客<Elasticsearch-6.7.0系列(一)9200端口 .tar.gz版 ...

  8. 安装pytorch成功但cuda不可用

    贴上我看的教程https://zhuanlan.zhihu.com/p/26871672 一开始想用pycharm装pytorch,但不知道为什么一直失败.后来只能conda pip安装 但conda ...

  9. ERROR 2002 (HY000): Can't connect to local MySQL server through socket '/var/lib/mysql/mysql.sock' (13)解答

    我在使用mysqll客户端连接我的mysql服务器的时候,出现了上述的问题.我的操作系统是ubuntu,安装版本是对应的64位服务器.我的服务器的启动方式是sudo service mysql sta ...

  10. 2018-2019-2 20175311 实验二 《Java开发环境的熟悉》实验报告

    2018-2019-2 20175303 实验二 <Java开发环境的熟悉>实验报告 一.实验准备 1.了解掌握实验所要用到的三种代码 伪代码 产品代码 测试代码 2.IDEA中配置单元测 ...