当前位置: 首页 > news >正文

东莞网站的建设大岭山镇网站建设公司

东莞网站的建设,大岭山镇网站建设公司,python做网站的书,WordPress任务主题我的飞书:https://rvg7rs2jk1g.feishu.cn/docx/TVlJdMgYLoDJrsxAwMgcCE14nxt 使用Springfox Swagger生成API,并导入Postman,完成API单元测试 Swagger: 是一套API定义的规范,按照这套规范的要求去定义接口及接口相关信息,再通过可…

我的飞书:https://rvg7rs2jk1g.feishu.cn/docx/TVlJdMgYLoDJrsxAwMgcCE14nxt

使用Springfox Swagger生成API,并导入Postman,完成API单元测试

Swagger: 是一套API定义的规范,按照这套规范的要求去定义接口及接口相关信息,再通过可以解析这套规范工具,就可以生成各种格式的接口文档,以及在线接口调试页面,通过自动文档的方式,解决了接口文档更新不及时的问题。

Springfox: 是对Swagger规范解析并生成文档的一个实现。

代码配置

因为 Springfox 版本(3.0) 的问题,他的版本只有在 springBoot 2.5x能够进行使用,如果我们这里使用springBoot 2.7x及以上就会出现兼容性问题,此时我们就要进行一些适配操作

这里我使用的springBoot版本为 2.7.6

我们需要在 pom 文件中加入对应依赖

统一管理版本,在properties标签中加入版本号

<!-- springfox -->
<springfox-boot-starter.version>3.0.0</springfox-boot-starter.version>

引入依赖

<!-- API文档生成,基于swagger2 -->
<dependency><groupId>io.springfox</groupId><artifactId>springfox-boot-starter</artifactId><version>${springfox-boot-starter.version}</version>
</dependency>
<!-- SpringBoot健康监控(只是为了方便关注spring状态) -->
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

编写配置类

将以下代码添加至项目中

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;// 配置类
@Configuration
// 开启Springfox-Swagger
@EnableOpenApi //生成 API 功能
public class SwaggerConfig {/*** Springfox-Swagger基本配置* @return*/@Beanpublic Docket createApi() {Docket docket = new Docket(DocumentationType.OAS_30).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.example.forum.controller")) //填写自己项目中的controller包路径.paths(PathSelectors.any()).build();return docket;}// 配置API基本信息,以下信息都为自定义信息private ApiInfo apiInfo() {ApiInfo apiInfo = new ApiInfoBuilder().title("") //标题.description("") //描述.contact(new Contact("name", "url", "email")).version("1.0").build();return apiInfo;}/*** 解决SpringBoot 2.6.0以上与Swagger 3.0.0 不兼容的问题* 复制即可**/@Beanpublic WebMvcEndpointHandlerMapping webEndpointServletHandlerMapping(WebEndpointsSupplier webEndpointsSupplier,ServletEndpointsSupplier servletEndpointsSupplier,ControllerEndpointsSupplier controllerEndpointsSupplier,EndpointMediaTypes endpointMediaTypes, CorsEndpointProperties corsProperties,WebEndpointProperties webEndpointProperties, Environment environment) {List<ExposableEndpoint<?>> allEndpoints = new ArrayList();Collection<ExposableWebEndpoint> 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(), new EndpointLinksResolver(allEndpoints, basePath),shouldRegisterLinksMapping, null);}private boolean shouldRegisterLinksMapping(WebEndpointProperties webEndpointProperties, Environment environment,String basePath) {return webEndpointProperties.getDiscovery().isEnabled() && (StringUtils.hasText(basePath)|| ManagementPortType.get(environment).equals(ManagementPortType.DIFFERENT));}}

修改配置文件

在yml文件中加入新的配置,这里必须加入!!不然会出现不适配的问题,因为使用的SpringBoot相对于Springfox来说是高版本

spring:mvc:path match:matching-strategy: ant_path_matcher

API常用注解以及使用方法

@Api

作用在 Controller 上,对控制器类进行说明

tags = " 说明该类的作用,可以在前台界面上看到的注释 "

@ApiModel

作用在相应的类上,对返回响应数据的说明

@ApiModelProperty

作用在类的属性上,对属性的说明,也就是具体的对象上

@ApiOperation

作用在具体的方法上,对API接口的说明

@ApiParam

作用在方法中的每一个参数上,对参数的属性进行说明

访问API列表

启动程序,在浏览器中输入网址: http://127.0.0.1:项目端口号/swagger-ui/index.html

进入对应网页

连接 postman

获取 API 地址,获取API资源地址之后复制

打开 postman,选择要复制到的地方.选择 Woekspaces ,选择 My Workspace

在左边工具栏中找到 APIs ,选择 import ,输入刚才复制的网址

http://www.yayakq.cn/news/511360/

相关文章:

  • wordpress建网站北京建设集团网站首页
  • 中国建设银行官网站e路护航中国机械加工网app
  • 网站建设 数据归属十八把网站做扇子
  • 邯郸医院网站建设用手机怎么制作软件
  • it行业网站建设哈尔滨可以做网站的公司
  • 品牌网站设计网站市场推广和销售的区别
  • 公司网站设计师心理咨询网站开发
  • 东莞做网站还赚钱吗网络平台怎么制作
  • 广元市建设银行网站c 网站开发需要学什么软件有哪些
  • 织梦网站如何做地区分站提交网址给百度
  • 企业网站建设周期养殖舍建设网站
  • 佛山企业设计网站建设wordpress小程序发表文章
  • 网站建设服务费入什么科目郑州建设信息网站
  • 可信的手机网站建设湖南二维码标签品牌
  • 课程网站建设毕业设计做网站用什么系统较好
  • 学c还是网站开发完成公司门户网站建设
  • seo整站优化系统做电子手抄报的网站
  • 开封网站制作wordpress 互动模块
  • 模板网建站福建省建设银行网站
  • 网站开发交付验收文档国外网站如何建设
  • 老铁推荐个2021网站好吗郑州软件开发公司网站
  • 台州做网站比较好的有哪些丹阳网站建设机构
  • 网站建设个人接单海外 推广网站
  • 网站空间后台网站建设中什么是一栏
  • 菏泽企业网站建设json api wordpress
  • 专门做ryona的网站东莞凤岗房价
  • 怎么做网站报价表丰县建设局规划局网站
  • 网站内容建设的布局做网站 需求怎么写
  • 如何做自媒体和网站签约赚点击网站网业设计
  • 北京产品网站建设济南高端网站设计