目录

• 一，Swagger简介
• 二，集成Swagger
• • 1，引依赖
  • 2，写配置
  • 3，配置说明
  • • 3.1，暴露接口
    • 3.2，补充信息
  • 4，加注解
  • • 注解说明
• 三，测试

一，Swagger简介

开发时经常会出现下面这种情况——“不熟”的接口


因为业务的需要接口文档可能会发生改变，前后端交互上经常会出现参数不符的情况，通过Excel或者Word维护接口文档，会存在时效性较差的问题，而Swagger正是解决这一痛点的利器。在代码中加入注解，可以实时更新接口。

二，集成Swagger

1，引依赖

		io.springfoxspringfox-boot-starter3.0.0

2，写配置

package com.tick.tack.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.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;@Configuration
@EnableOpenApi
public class SwaggerConfig {/*** 创建API应用* apiInfo() 增加API相关信息* 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，* 本例采用指定扫描的包路径来定义指定要建立API的目录。** @return*/@Beanpublic Docket desertsApi1() {return new Docket(DocumentationType.OAS_30).apiInfo(apiInfo("滴答社区——Swagger3.0", "1.0")).select().apis(RequestHandlerSelectors.basePackage("com.tick.tack.manager.controller")).paths(PathSelectors.any()).build().groupName("人员信息").enable(true);}//再定义一个Docket@Beanpublic Docket desertsApi2() {return new Docket(DocumentationType.OAS_30).apiInfo(apiInfo("滴答社区——Swagger3.0", "1.0")).select().apis(RequestHandlerSelectors.basePackage("com.tick.tack.login.controller")).paths(PathSelectors.any()).build().groupName("登录").enable(true);}/*** 创建该API的基本信息（这些基本信息会展现在文档页面中）* 访问地址：http://ip:port/swagger-ui.html** @return*/private ApiInfo apiInfo(String title, String version) {return new ApiInfoBuilder().title(title).description("滴答社区接口测试页面").contact(new Contact("GMS", "https://blog.csdn.net/weixin_44924882?spm=1011.2415.3001.5343", "1457205312@qq.com")).termsOfServiceUrl("https://www.zybuluo.com/mdeditor#2281023-full-reader").version(version).build();}
}

3，配置说明

3.1，暴露接口

一个Docket就是一个definition，表示哪几个接口暴露给Swagger页面，apis指定包路径时到controller层即可。
enable代表是否启用这个分组，为false表示该定义暂不生效。

3.2，补充信息

ApiInfo是对Swagger页面一些提示信息的说明，包含一些跳转链接。

4，加注解

package com.tick.tack.manager.controller;import com.baomidou.mybatisplus.core.metadata.IPage;
import com.tick.tack.common.Result;
import com.tick.tack.manager.entity.User;
import com.tick.tack.manager.service.IUserService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;import java.util.*;@RestController
@RequestMapping("/user")
//定义swagger页面信息
@Api(tags = "人员信息查询接口")
public class UserController {@Autowiredprivate IUserService userService;@GetMapping("/queryPage")@ApiOperation(value = "人员信息分页查询方法", notes = "查看人员信息是否返回成功")public Result queryPage(Integer pageNumber, Integer pageSize, String name) {IPage userIPage = userService.queryPage(pageNumber, pageSize, name);return Result.success(userIPage);}
}

注解说明

三，测试

点击要进行测试的方法，在展开列表中选择Try it out

输入相应的参数，点击Execute执行，在Response就可以看到返回的消息了。