天津建设银行官网站首页,企业微信网站开发,网站展示型和营销型有什么区别,南京装修公司十大排名榜目录 1. pom.xml中引用依赖 2. 引入相关的依赖 3. 编写配置类 4. application.yml 中添加配置 5. API 常用注解 6. 访问 API 列表 7. API 导入 Postman 使用 Springfox Swagger生成 API#xff0c;并导入 Postman#xff0c;完成API单元测试。 Swagger 简介#xff1a;Swag… 目录 1. pom.xml中引用依赖 2. 引入相关的依赖 3. 编写配置类 4. application.yml 中添加配置 5. API 常用注解 6. 访问 API 列表 7. API 导入 Postman 使用 Springfox Swagger生成 API并导入 Postman完成API单元测试。 Swagger 简介Swagger 是⼀套 API 定义的规范 按照这套规范的要求去定义接口及接口相关信息 再通过可以解析这套规范工具就可以生成各种格式的接口文档以及在线接口调试页面通过自动文档的方式解决了接口文档更新不及时的问题。 Springfox 简介是对 Swagger 规范解析并生成文档的⼀个实现。 1. pom.xml中引用依赖
统⼀管理版本在 properties 标签中加入版本号
springfox-boot-starter.version3.0.0/springfox-boot-starter.version
3.0.0 版本对应 Spring Boot 2.6 之前的版本但是随着 Spring Boot 的更新 Springfox 并没有进行同步的更新所以存在一些兼容性问题因此我们选择使用 SpringBoot 2.7.6 版本。
2. 引入相关的依赖
!-- API⽂档⽣成基于swagger2 --
dependencygroupIdio.springfox/groupIdartifactIdspringfox-boot-starter/artifactIdversion${springfox-boot-starter.version}/version
/dependency
!-- SpringBoot健康监控 --
dependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-actuator/artifactId
/dependency
3. 编写配置类 在com.bitejiuyeke.forum.config 包下新建SwaggerConfig.java 解决 SpringBoot 2.6.0 以上与 Springfox3.0.0 不兼容的问题涉及 SpringBoot 版本升级过程中的一 些内部实现变化具体说明在修改配置文件部分 将以下代码复制到 SwaggerConfig 类中
package com.example.demo.controller;import org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties;
import org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties;
import org.springframework.boot.actuate.autoconfigure.web.server.ManagementPortType;
import org.springframework.boot.actuate.endpoint.ExposableEndpoint;
import org.springframework.boot.actuate.endpoint.web.*;
import org.springframework.boot.actuate.endpoint.web.annotation.ControllerEndpointsSupplier;
import org.springframework.boot.actuate.endpoint.web.annotation.ServletEndpointsSupplier;
import org.springframework.boot.actuate.endpoint.web.servlet.WebMvcEndpointHandlerMapping;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.util.StringUtils;
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;import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
/*** Swagger配置类*/
// 配置类
Configuration
// 开启Springfox-Swagger
EnableOpenApi
public class SwaggerConfig {/*** Springfox-Swagger基本配置* return*/Beanpublic Docket createApi() {Docket docket new Docket(DocumentationType.OAS_30).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage(com.example.demo.controller)).paths(PathSelectors.any()).build();return docket;}// 配置API基本信息private ApiInfo apiInfo() {ApiInfo apiInfo new ApiInfoBuilder().title(论坛系统API).description(论坛系统前后端分离API测试).contact(new Contact(Test,https://hello.fprum.com, 1111111111qq.com)).version(1.0).build();return apiInfo;}/*** 解决SpringBoot 6.0以上与Swagger 3.0.0 不兼容的问题* 复制即可**/Beanpublic WebMvcEndpointHandlerMappingwebEndpointServletHandlerMapping(WebEndpointsSupplier webEndpointsSupplier,ServletEndpointsSupplier servletEndpointsSupplier,ControllerEndpointsSupplier controllerEndpointsSupplier,EndpointMediaTypes endpointMediaTypes, CorsEndpointProperties corsProperties,WebEndpointProperties webEndpointProperties, Environment environment) {ListExposableEndpoint? allEndpoints new ArrayList();CollectionExposableWebEndpoint webEndpoints webEndpointsSupplier.getEndpoints();allEndpoints.addAll(webEndpoints);allEndpoints.addAll(servletEndpointsSupplier.getEndpoints());allEndpoints.addAll(controllerEndpointsSupplier.getEndpoints());String basePath webEndpointProperties.getBasePath();EndpointMapping endpointMapping new EndpointMapping(basePath);boolean shouldRegisterLinksMapping this.shouldRegisterLinksMapping(webEndpointProperties, environment,basePath);return new WebMvcEndpointHandlerMapping(endpointMapping, webEndpoints,endpointMediaTypes,corsProperties.toCorsConfiguration(), newEndpointLinksResolver(allEndpoints, basePath),shouldRegisterLinksMapping, null);}private boolean shouldRegisterLinksMapping(WebEndpointPropertieswebEndpointProperties, Environment environment,String basePath) {return webEndpointProperties.getDiscovery().isEnabled() (StringUtils.hasText(basePath)||ManagementPortType.get(environment).equals(ManagementPortType.DIFFERENT));}
}4. application.yml 中添加配置 在 spring 节点下添加 mvc 配置项 由于 SpringBoot 2.6 之后版本把 SpringMVC 路径匹配策略修改为 MatchingStrategy. PATH_PATTERN_PARSER; 而 Springfox-Swagger 还没有更新版本我们暂时先把 路径匹配策略回退到之前的 MatchingStrategy. ANT_PATH_MATCHER mvc:path match:matching-strategy: ANT_PATH_MATCHER #Springfox-Swagger兼容性配置
5. API 常用注解 Api: 作用在 Controller 上对控制器类的说明 tags说明该类的作用可以在前台界面上看到的注解 ApiModel: 作用在响应的类上对返回响应数据的说明 ApiModelProerty:作用在类的属性上对属性的说明 ApiOperation: 作用在具体方法上对 API 接口的说明 ApiParam: 作用在方法中的每⼀个参数上对参数的属性进行说明
6. 访问 API 列表
启动程序在浏览器中输入网址http://127.0.0.1:58080/swagger-ui/index.html 可以正常运行并显示接口信息说明配置成功此时接口信息已经显示出来了可以分别针每个接口进测试具操作按页面指引即可。 点击“测试接口”出现如下图所示 选择对应的 API 列表点击“Try it out” 点击 Execute 图中箭头所指方向即为测试结果。
带有参数的同样可以进行测试 7. API 导入 Postman 获取 API 地址打开 Swagger 页面的 API 资源地址并复制 在 Postman 中导入 url 接下来输入参数
