【go语言】仅思路: 给gin-swagger集成knife4j

已于 2023-07-31 15:26:50 修改
阅读量839 收藏 1
点赞数 1
分类专栏： gin swagger 文章标签： gin 后端 golang
于 2023-04-03 17:36:02 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/2301_76933862/article/details/129886864
版权
文章介绍了如何将gin-swagger与knife4j结合，以提升前后端接口调试的效率。默认的swagger界面在测试接口时操作不便，而knife4j主要适用于springboot项目。文中提出了一个修改gin-swagger的UI部分，使两者能共存的思路，从而提供更友好的接口管理与测试环境。
摘要由CSDN通过智能技术生成

文章目录

前言

对于前后端联调来说， swagger是一个很不错的好工具， 可以查看接口参数，分组整理，并且测试接口查看返回数据。但是，默认的swagger网页使用起来不太方便（测试接口还得点击try out），而像knife4j这种，只有springboot项目使用起来才很方便。
下面提供一种给gin-swagger集成knife4j的思路。

更换前

在这里插入图片描述

更换后

在这里插入图片描述

思路

修改 gin-swagger 和 gin-swagger/files(UI部分), 其实两种ui界面可以共存。

other

这种人自己玩去吧
在这里插入图片描述

道着无为法自然
关注
专栏目录
Swagger-knife4j攻略（国产超强swagger文档）
此成非彼诚博客
11-19 7419
Swagger-knife4j攻略
Go的Gin框架整合Swagger
u013068184的博客
06-11 8138
最近在研究Go的Gin框架，本文简单记录怎么整合Swagger。 版本信息： gin v1.6.3 swag v1.6.7 首先下载安装Gin以及Swagger依赖包： go get -u github.com/gin-gonic/gin go get -u github.com/swaggo/swag/cmd/swag 若报以下错： go get github.com/gin-gonic/gin: module github.com/gin-gonic/gin: Get "https://proxy.
接入Swagger2（2） —— knife4j
江湖郎中
05-14 559
knife4j是基于Swagger2的一套API文档UI，是swagger-ui的替代方案，本文介绍了接入knife4j的最简单操作。
项目中集成knife4j
qq_41158525的博客
03-09 260
knife4j是为Java框架集成Swagger生成Api文档的增强解决方案。
快速集成Knife4j
LGD_GodV的博客
07-05 304
【代码】快速集成Knife4j。
knife4j介绍及使用
热门推荐
weixin_55076626的博客
09-30 2万+
knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名knife4j是希望它能像一把匕首一样小巧,轻量,并且功能强悍!其底层是对Springfox的封装，使用方式也和Springfox一致，只是对接口文档UI进行了优化。
神器：Knife4j ，太方便了，大爱。代替postman
大龄毕业生的博客
10-15 2502
在用postman做接口测试的时候，如果字段比较多，且对象比较多的时候，参数的填写就很耽误时间，Knife4j一切都为你自动生成，你只需要填写参数值就好了。简直不要太方便。 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.6.1</version> &l
gin-swagger:使用 Swagger 2.0 自动生成 RESTful API 文档的 gin 中间件
07-24
gin 中间件使用 Swagger 2.0 自动生成 RESTful API 文档。 用法 开始使用它 向您的 API 源代码添加注释，。 使用以下命令下载 for Go： $ go get -u github.com/swaggo/swag/cmd/swag 在包含main.go文件的 Go 项目...
golang-gin-restfulAPI-example-app：带有[Gin，MongoDB，gin-jwt，gin-sessions，gin-authz，gin-swagger，validate.v9，casbin，go-ini]的Golang Restful API示例
02-04
一个用go语言基于Gin写的restful风格api服务程序的例子。 项目特性 基于 使用数据库 权限验证 从session里取用户的角色进行权限管理 使用自动生成api文档 将gingin的validator.v8升级到 使用权限管理 使用识读配置...
gin-vue-admin_multi_db:将gin-vue-admin改为兼容多种数据库的版本
04-23
Gin-vue-admin是一个基于vue和gin开发的全栈前后端分离的后台管理系统，集成jwt鉴权，动态路由，动态菜单，casbin鉴权，表单生成器，代码生成器等功能，提供多种示例文件，让您把更多时间专注在业务开发上。...
gin-swagger-demo:杜松子酒摇摆演示
04-16
Gin swagger demo 本项目为 gin swagger 结合使用的 demo，在此案例中，添加了相关的使用案例；具体注释格式参考来自： 特性 方式自动监听文件变动，进行热重启 使用 tag 方式动态选择是否在编译中携带 swagger，...
gin-admin-cli:gin-admin 辅助工具，提供创建项目、快速生成功能模块的功能
05-03
gin-admin-cli - GinAdmin 辅助工具，提供创建项目、快速生成功能模块的功能 下载并使用 go get -u github.com/gin-admin/gin-admin-cli/v4 创建项目 USAGE: gin-admin-cli new [command options] [arguments...] ...
Knife4j，一个好用的自动生成接口文档工具
weixin_62395763的博客
05-18 721
只需要引入这一个接口文档依赖就可以了，多引入可能会冲突。-- 接口文档-->
支持国产，开源微服务架构项目之Knife4j使用
08-17 1616
欢迎关注转发留言。想获取学习资料关注微信公众号(IT小分享),回复 学习即可！ 今天看到了一条新闻，docker禁止国内被列入黑名单的公司使用了。IT行业未来一些广泛使用的技术会不会也被禁用呢?支持国产技术,势在必行！ 这次介绍一款国产开源Api文档接口生成技术-Knife4j。这款产品与swgger相比有以下优势，友好界面,离线文档，接口排序，安全控制，在线调试，文档清晰，容易上手。废话不多说，上界面比对。Knife4J官网(https://doc.xiaominfo.com) 1 Knife4J界
Knife4j_接口概述、常用注解详解、搭建swagger项目、功能概述
所得皆惊喜
10-07 4609
Knife4j_接口概述、常用注解详解、搭建swagger项目、功能概述
Swagger与knife框架生成接口文档
SuiHao
03-04 480
在项目中自动生成接口文档使用步骤 官网：https://swagger.io Knife使用步骤: 1).在pom.xml导入坐标 <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>3.0.2</version> </d
Knife4j ( 增强版Swagger )
m0_60708917的博客
10-30 176
Knife4j它是对swagger在线接口文档的一个增强，在swagger上做了一个更好看皮肤的同时加了一些新的功能。Knife4j 由国人程序员萧明于 2017 年开源，距今为止 Star 数已经超过了 6.1k 了。Swagger 可以较好的接口接口文档的交互问题，以一套标准的规范定义接口以及相关的信息，就能做到生成各种格式的接口文档，生成多种语言和客户端和服务端的代码，以及在线接口调试页面等等。只需要更新 Swagger 描述文件，就能自动生成接口文档，做到前端、后端联调接口文档的及时性和便利性。
彻底搞懂Swagger&Knife4j使用方法
gaohuanjie的专栏
11-16 3059
本文详细讲解了Swagger和Knife4j用法！
三十六、Gin注册功能-检查账号是否存在
最新发布
Boo_T的博客
09-10 428
在register.go中进行调用IsExist方法。2、在cms.go中进行初始化数据库连接方法。1、在cms.go中添加数据库连接方法。
gin-swagger:使用 swagger 2.0 自动生成 restful api 文档的 gin 中间件
09-02
gin-swagger是一个使用swagger 2.0来自动生成RESTful API文档的gin中间件。 swagger是一个针对RESTful API的规范和工具，它可以通过Swagger注解来定义API的各种元数据，包括API的路径、请求参数、响应数据等信息。这些元数据可以通过swagger-ui来自动生成API文档，方便开发者查阅和测试API。 而gin是一个用Golang编写的轻量级Web框架，具有高性能和高灵活性的特点。它支持中间件的使用，可以方便地扩展功能。 gin-swagger就是结合了swagger和gin的中间件，它提供了一种简单的方式来自动化生成RESTful API文档。使用gin-swagger，开发者只需要在API的处理函数中添加一些swagger注解，如路径、请求参数、响应数据等信息，然后在启动应用时将gin-swagger中间件加入到gin的路由处理链中。 当应用启动后，访问特定的路径，例如/swagger/doc.json，可以得到包含所有API元数据的JSON文档。通过将这个文档提供给swagger-ui，就可以自动生成API文档页面，方便开发者查看和测试API。 总之，gin-swagger是一个非常实用的工具，它使得开发者在使用gin框架开发RESTful API时，能够方便地自动生成API文档，提高开发效率。同时，通过API文档的可视化呈现，也能够帮助开发者更好地理解和使用API。
评论 6
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值