网站建设大量定制阶段,个人注册公司流程和费用,wordpress的站点地址怎么设置,建设银行东莞招聘网站一、基础概念
knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望它能像一把匕首一样小巧,轻量,并且功能强悍!
Knif4j#xff08;原名为 Swagger-Bootstrap-UI#xff09;是一款基于 Swagger 实现的文档管理工具原名为 Swagger-Bootstrap-UI是一款基于 Swagger 实现的文档管理工具旨在简化接口文档的编写和管理。它提供了一套美观的界面能够自动生成接口文档并支持在线调试接口。Knif4j 是针对 Java 后端项目的接口文档管理工具可以与 Spring Boot 等框架很好地集成使用。
二、Knif4j 主要具有以下特点 自动生成接口文档根据代码中的 Swagger 注解Knif4j 能够自动生成接口文档包括接口信息、请求参数、响应参数等极大地减少了编写接口文档的工作量。 可视化界面Knif4j 提供了美观的界面以树形结构展示接口信息用户可以方便地浏览和查看接口文档。 在线调试接口Knif4j 支持在线调试接口用户可以在界面上直接输入参数并发送请求实时查看接口的返回结果方便进行接口测试和调试。 权限控制Knif4j 支持对接口文档的访问权限控制可以设置不同的用户角色和权限保障接口文档的安全性。
5.基础特性兼容OpenAPI 2.0和OpenAPI 3.0提供自定义文档、动态参数调试、I18n、接口排序、导出等功能。
6.增强扩展 基于Springfox框架和Swagger2规范的自动注入starter以及基于Springdoc-openapi和OAS3规范的自动注入starter。
7.框架适配适配Spring MVC、Spring Boot 2.2至3.0、Spring WebFlux等框架。
8.社区生态包括基于Servlet体系的微服务聚合中间件Knife4jAggregation、基于Spring Cloud Gateway网关聚合的微服务聚合中间件Knife4jDesktop。
三、使用步骤
1.导入Maven坐标添加依赖
dependencygroupIdcom.github.xiaoymin/groupIdartifactIdknife4j-spring-boot-starter/artifactId
/dependency
2.在配置类中加入相关配置 /*** 通过knife4j生成接口文档* return*/Beanpublic Docket docket1() {log.info(准备生成接口文档......);ApiInfo apiInfo new ApiInfoBuilder().title(接口文档).version(2.0).description(项目接口文档).build();Docket docket new Docket(DocumentationType.SWAGGER_2).groupName(管理端接口).apiInfo(apiInfo).select().apis(RequestHandlerSelectors.basePackage(com.sky.controller.admin)).paths(PathSelectors.any()).build();return docket;}
3.设置静态资源否则接口文档无法访问
/*** 设置静态资源映射* param registry
*/
protected void addResourceHandlers(ResourceHandlerRegistry registry) {registry.addResourceHandler(/doc.html).addResourceLocations(classpath:/META-INF/resources/);registry.addResourceHandler(/webjars/**).addResourceLocations(classpath:/META-INF/resources/webjars/);
}
4.接口文档访问路径http://localhost:8080/doc.html
5.常用注解 四、YaPi和Swagger的区别
功能对比 Swagger 是一组用于编写基于REST的API的开源工具它提供了生成、描述、调用和可视化RESTful风格的Web服务的规范和框架。Swagger支持自动发现和代码生成便于后端集成但界面设计较为简单。 YApi 是一个高效、易用、功能强大的API管理平台它不仅提供了常用的接口管理功能还包括权限管理、Mock数据、Swagger数据导入等功能。YApi支持导入导出方便从Swagger迁移数据而且支持批量接口测试和自动化测试。13
2.使用方式对比 Swagger 可以通过Swagger UI进行在线文档的查看和测试但目前还不支持批量接口测试。Yapi 是设计阶段使用的工具管理和维护接口 YApi 需要导入文档虽然也可以通过Swagger轮询导入但与Swagger相比YApi支持权限管理和团队协作等功能。Swagger 在开发阶段使用的框架帮助后端开发人员做后端的接口测试
3.界面设计对比 Swagger 的界面更像是一个接口文档返回响应体以代码形式展示且无法格式化。 YApi 的界面更像是一个管理系统提供了清晰的接口管理和调试功能如可折叠的返回数据和批量测试接口。
