Springboot integrates swagger2

Kind little black brother 2021-01-22 15:52:54
springboot integrates swagger2 swagger


I recently joined a new company , After the completion of the project development, we found that there is no write interface API Documentation tool , Asked the group leader , The group leader told me that it's usually oral communication , There's no need for interface documentation ...... I want to save some saliva , So simply integrate one swagger2, Code below .

Jar Packet dependency

We're going to use Maven project , So directly in pom.xml Rely on , Because our project uses Springboot-1.3.5, So the dependence is relatively low , If it's a high-level partner , You can download the corresponding version dependency .

Enclosed maven Warehouse address :https://mvnrepository.com/search?q=swagger2

 <!-- swagger2-->

Configuration class

Then we need to build a new one swagger Configuration class

package net.XXXX.xx.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import springfox.documentation.service.Parameter;
import springfox.documentation.builders.ParameterBuilder;
import java.util.ArrayList;
import java.util.List;
public class SwaggerConfig {
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apis(RequestHandlerSelectors.basePackage("net.XXX.xx"))// Here's your own package structure
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title(" Interface sample document ")
.description(" Interface document Demo")
// The following code can be handled as appropriate , Because we need to have token verification , So we need to configure it token Input box , The following code does this function
private List<Parameter> globalOperation(){
// add to head Parameter configuration start
ParameterBuilder tokenPar = new ParameterBuilder();
List<Parameter> pars = new ArrayList<>();
// first token For the reference key, the second token by swagger The values displayed on the page
tokenPar.name("token").description("token").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
return pars;

Be careful

If you have filters in your project , Need to put swagger Release the access address of , Release the following address .


Example Controller

Here we use a GET Ask for an example , Mark it Controller And parameters , Ignore the code content ~

@Api(value = "RevenueBudgetReisterController", description = " Revenue budget registration API")
public class RevenueBudgetReisterController extends BaseController {
private RevenueBudgetRegisterService registerService;
public RevenueBudgetReisterController(RevenueBudgetRegisterService registerService) {
this.registerService = registerService;
@ApiOperation(value = " Get a record ", notes = " Get detailed records of the budget ")
@ApiImplicitParam(name = "year", value = " year ", required = true, dataType = "String", paramType = "query"),
@ApiImplicitParam(name = "dictionaryName", value = " Subject name ", required = false, dataType = "String", paramType = "query"),
@ApiImplicitParam(name = "departmentId", value = " department ID", required = true, dataType = "String", paramType = "query")
@RequestMapping(value = "/v1.0/revenueBudgetTetails", method = RequestMethod.GET)
public ResultDto revenueBudgetTetails(String year, String dictionaryName, String departmentId) {
if (null == year || year.equals("")
|| null == departmentId || "".equals(departmentId)) {
return new ResultDto(ResultDto.CODE_FAIL, RevenueBudgetDetailsController.ERROR_DATA, null);
List<RevenueBudgetDetailsVo> details = registerService.details(year, dictionaryName, departmentId);
return new ResultDto(ResultDto.CODE_SUCCESS, RevenueBudgetDetailsController.SUCCEEDED, details);

Project start

Access address :http://localhost:8006/swagger-ui.html#/     Please change the address and port number to the corresponding one , What I set up here is 8006

bingo!~  This interface means success !(  The old man touched his bald head excitedly , Got out of the wheelchair , Shed happy tears .....)

And then we just click in one

The input parameters of our interface are shown here , And how to request , If we configure it token Input box , Here it will show .

About starting up

Maybe integrate swagger The following exception will appear .

 Integrate swagger2 Report errors :java.lang.NoSuchMethodError: com.google.common.XXX

This is because swagger There's a Google built-in guava package , And there are also in the project guava Dependence , Conflicts caused by version inconsistencies , We need to match the versions , Or eliminate the dependency of lower version , I've lowered the version here , Originally, the project relied on swagger-2.9.2 Version of , So it's down to swagger-2.4.0 edition , Perfect solution ~


Swagger Commonly used annotations

swagger Annotations indicate that the interface will generate documents , Include interface name 、 Request method 、 Parameters 、 Return information and so on .

  • @Api: Decorate the whole class , describe Controller The role of
  • @ApiOperation: A method that describes a class , Or an interface
  • @ApiParam: Single parameter description
  • @ApiModel: Use objects to receive parameters
  • @ApiProperty: When receiving parameters with objects , A field describing an object
  • @ApiResponse:HTTP In response to 1 Description (s)
  • @ApiResponses:HTTP Respond to the overall description
  • @ApiIgnore: Use this annotation to ignore this API
  • @ApiError : Information returned in the event of an error
  • @ApiParamImplicitL: A request parameter
  • @ApiParamsImplicit : Multiple request parameters
  • @ApiImplicitParams: Used in the method of request , Represents a set of parameter descriptions
  • @ApiImplicitParam: Parameter description , Use in @ApiImplicitParams in

That's all for this tutorial , Thank you for reading , Please forgive me if there is something wrong with it !

本文为[Kind little black brother]所创,转载请带上原文链接,感谢

  1. 【计算机网络 12(1),尚学堂马士兵Java视频教程
  2. 【程序猿历程,史上最全的Java面试题集锦在这里
  3. 【程序猿历程(1),Javaweb视频教程百度云
  4. Notes on MySQL 45 lectures (1-7)
  5. [computer network 12 (1), Shang Xuetang Ma soldier java video tutorial
  6. The most complete collection of Java interview questions in history is here
  7. [process of program ape (1), JavaWeb video tutorial, baidu cloud
  8. Notes on MySQL 45 lectures (1-7)
  9. 精进 Spring Boot 03:Spring Boot 的配置文件和配置管理,以及用三种方式读取配置文件
  10. Refined spring boot 03: spring boot configuration files and configuration management, and reading configuration files in three ways
  11. 精进 Spring Boot 03:Spring Boot 的配置文件和配置管理,以及用三种方式读取配置文件
  12. Refined spring boot 03: spring boot configuration files and configuration management, and reading configuration files in three ways
  13. 【递归,Java传智播客笔记
  14. [recursion, Java intelligence podcast notes
  15. [adhere to painting for 386 days] the beginning of spring of 24 solar terms
  16. K8S系列第八篇(Service、EndPoints以及高可用kubeadm部署)
  17. K8s Series Part 8 (service, endpoints and high availability kubeadm deployment)
  18. 【重识 HTML (3),350道Java面试真题分享
  19. 【重识 HTML (2),Java并发编程必会的多线程你竟然还不会
  20. 【重识 HTML (1),二本Java小菜鸟4面字节跳动被秒成渣渣
  21. [re recognize HTML (3) and share 350 real Java interview questions
  22. [re recognize HTML (2). Multithreading is a must for Java Concurrent Programming. How dare you not
  23. [re recognize HTML (1), two Java rookies' 4-sided bytes beat and become slag in seconds
  24. 造轮子系列之RPC 1:如何从零开始开发RPC框架
  25. RPC 1: how to develop RPC framework from scratch
  26. 造轮子系列之RPC 1:如何从零开始开发RPC框架
  27. RPC 1: how to develop RPC framework from scratch
  28. 一次性捋清楚吧,对乱糟糟的,Spring事务扩展机制
  29. 一文彻底弄懂如何选择抽象类还是接口,连续四年百度Java岗必问面试题
  30. Redis常用命令
  31. 一双拖鞋引发的血案,狂神说Java系列笔记
  32. 一、mysql基础安装
  33. 一位程序员的独白:尽管我一生坎坷,Java框架面试基础
  34. Clear it all at once. For the messy, spring transaction extension mechanism
  35. A thorough understanding of how to choose abstract classes or interfaces, baidu Java post must ask interview questions for four consecutive years
  36. Redis common commands
  37. A pair of slippers triggered the murder, crazy God said java series notes
  38. 1、 MySQL basic installation
  39. Monologue of a programmer: despite my ups and downs in my life, Java framework is the foundation of interview
  40. 【大厂面试】三面三问Spring循环依赖,请一定要把这篇看完(建议收藏)
  41. 一线互联网企业中,springboot入门项目
  42. 一篇文带你入门SSM框架Spring开发,帮你快速拿Offer
  43. 【面试资料】Java全集、微服务、大数据、数据结构与算法、机器学习知识最全总结,283页pdf
  44. 【leetcode刷题】24.数组中重复的数字——Java版
  45. 【leetcode刷题】23.对称二叉树——Java版
  46. 【leetcode刷题】22.二叉树的中序遍历——Java版
  47. 【leetcode刷题】21.三数之和——Java版
  48. 【leetcode刷题】20.最长回文子串——Java版
  49. 【leetcode刷题】19.回文链表——Java版
  50. 【leetcode刷题】18.反转链表——Java版
  51. 【leetcode刷题】17.相交链表——Java&python版
  52. 【leetcode刷题】16.环形链表——Java版
  53. 【leetcode刷题】15.汉明距离——Java版
  54. 【leetcode刷题】14.找到所有数组中消失的数字——Java版
  55. 【leetcode刷题】13.比特位计数——Java版
  56. oracle控制用户权限命令
  57. 三年Java开发,继阿里,鲁班二期Java架构师
  58. Oracle必须要启动的服务
  59. 万字长文!深入剖析HashMap,Java基础笔试题大全带答案
  60. 一问Kafka就心慌?我却凭着这份,图灵学院vip课程百度云