swaggo使用教程

最新推荐文章于 2024-06-22 20:09:02 发布
最新推荐文章于 2024-06-22 20:09:02 发布
阅读量626 收藏
点赞数
分类专栏： 探索编码世界 文章标签： swagger swaggo go
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xwh3165037789/article/details/132870725
版权
本文档介绍了如何使用swaggo在Go项目中生成Swagger接口文档和在线测试页面。首先讲解了安装与初始化，包括安装插件和依赖，确保在正确目录下生成docs文件夹和docs.go文件。接着，阐述了基本命令，如@Summary、@Param等注解的使用方法。此外，还详细说明了如何在原生net/http库中结合swaggo，以及如何下载和整合依赖以实现在线API文档和测试功能。
摘要由CSDN通过智能技术生成

安装与初始化

  1. 安装插件

go install github.com/swaggo/swag/cmd/swag@latest

  1. 安装依赖

go get -u github.com/swaggo/swag/cmd/swag

  1. 在包含main.go文件的项目根目录运行swag init。这将会解析注释并生成需要的文件（docs文件夹和docs/docs.go）。

swag init

一定要在main.go的统计目录下，不然会出现如下错误：

在这里插入图片描述
切换到main.go统计目录后重新生成：

在这里插入图片描述
生成了一个docs目录

在这里插入图片描述
在这里插入图片描述
上述文件是根据swagger的注解生成的，虽然现在还没有swagger的注解

了解本专栏 订阅专栏 解锁全文 超级会员免费看
xvwen
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
订阅专栏
golang swagger
qq_36020617的博客
10-22 1580
我看网上很多关于golang gin整合swagger的教程，但都写的比较模糊，所以我自己整理了一个golang引入swagger的教程，希望能帮到大家。
Go语言使用swagger生成接口文档的方法
09-16
在Go语言中，使用Swagger生成接口文档是一种高效且自动化的方式，可以帮助开发者轻松地创建和维护RESTful API的文档。Swagger是一种接口描述语言，基于JSON，主要用于定义和理解RESTful服务的结构。它与一系列开源...
golint-docker：swaggo docker映像，供无人机使用
02-14
golint-docker golint docker镜像，供无人机使用 用法 docker run --rm -v your_project_path:/project -w /project kenretto/golint 默认命令 golint ./...
【山东大学软件学院 21 级项目实训】在Gin框架下引入Swaggo生成API文档
最新发布
Kelvin Cooper
06-22 281
在现代 Web 开发中，API 文档对于开发者之间的协作至关重要。Swaggo 是一个用于自动生成 API 文档的工具，它通过注释的方式生成符合 OpenAPI 规范的文档。本文将介绍如何在 Gin 框架下引入 Swaggo 并生成 API 文档。
swaggo/swag
JunChow
01-05 3053
swaggo/swag 提供了Go版本的Swagger自动生产RESTful API文档，其做法是在代码中按Swaggo的格式编写API注释，然后Swaggo会去解析这些注释，生成Swagger的文档以及托管到Web的框架代码，最终将代码编译到Web应用中，达到API文档托管的目的。 go-swagger是一套完整且功能齐全的高性能API组件，可与Swagger-API一起使用，分为三块分别是服务...
Swaggo快速上手
delete_you的博客
01-22 1750
快速上手使用swaggo并整合到gin中去
【swaggo】swaggo使用详解
SauryN的博客
12-26 4836
go 使用swagger工具swaggo，与gin集成
GO项目集成swagger
qq_45745830的博客
11-16 927
go结合swagger
golang-swagger安装步骤
lideqiang110119的博客
03-23 1052
/ @Param name query string true "姓名"// @Summary 测试helloworld。// @Description 测试helloworld。// @title golang api 框架。// @Tags 测试。
swagger:使用 Swagger 2.0 自动生成 RESTful API 文档的 Iris 中间件
05-29
使用以下命令下载 for Go：$ go get -u github.com/swaggo/swag/cmd/swag 在包含main.go文件的 Go 项目根文件夹中运行 ， 将解析注释并生成所需文件（ docs文件夹和docs/doc.go ）。 $ swag init 使用以下命令下载...
swag:使用Swagger 2.0 for Go自动生成RESTful API文档
04-28
赃物 :globe_showing_Europe-Africa: ∙ Swag将Go注释转换为Swagger文档2.0。 我们已经为流行的创建了各种插件。 这使您可以快速与现有Go...$ go get -u github.com/swaggo/swag/cmd/swag 要从源代码构建，您需要Go
echo-swagger:回声中间件，以使用Swagger 2.0自动生成RESTful API文档
05-04
$ swag init通过使用以下命令下载 ： $ go get -u github.com/swaggo/echo-swagger 并在您的代码中导入以下内容： import "github.com/swaggo/echo-swagger" // echo-swagger middleware规范示例： package main...
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 项目...
基于 Gin 进行模块化设计的 API 框架，封装了常用功能，使用简单，致力于进行快速的业务研发.zip
02-02
5. 支持 [Swagger](swaggo/gin-swagger) 接口文档生成 6. 支持 [GraphQL](99designs/gqlgen) 查询语言 7. 支持 trace 项目内部链路追踪 8. 支持 [pprof](gin-contrib/pprof) 性能剖析 9. 支持 errno 统一定义错误...
fiber-swagger:光纤中间件可通过Swagger 2.0自动生成RESTful API文档
05-15
$ go get -u github.com/swaggo/swag/cmd/swag 在包含main.go文件的Go项目根文件夹中运行 ， 将解析注释并生成所需文件（ docs文件夹和docs/doc.go ）。 $ swag init 使用以下方法下载 ： $ go get -u github....
斯普林菲尔德银行
02-12
目录产品特点使用RESTful端点使用的基于JWT的身份验证使用Postgres数据库连接池数据库迁移 使用配置环境变量具有上下文信息结构化日志使用正确的http状态代码进行错误处理幂等请求指标/健康终点使用swaggo / 生成的...
Swagger-go学习笔记
氷的博客
10-10 430
在前后端分离的项目开发过程中，如果后端开发人员能够提供一份清晰明了的接口文档，那么就能极大地提高前后端开发人员的沟通效率和开发效率。可是编写接口文档历来都是令人头痛的，而且后续接口文档的维护也十分耗费精力。最好是有一种方案能够既满足我们输出文档的需要又能随代码的变更自动更新，而Swagger正是那种能帮我们解决接口文档问题的工具。
swaggo使用demo
zhangkaixuan456的博客
04-28 157
执行完毕后，将会在docs目录下生成swagger.json和index.html文件。打开index.html文件即可查看API接口文档。以上就是Swaggo注解的详细使用示例，希望对你有所帮助！如果你想了解更多Swaggo的用法，可以参考Swaggo官方文档。执行完毕后，将会在项目根目录下生成docs目录和docs/swagger.json文件。括请求方法、请求路径等。
swaggo 格式化
07-28
要使用 swaggo 格式化你的代码，你需要按照以下步骤操作： 1. 确保你已经在项目中集成了 swaggo。你可以通过在终端中运行以下命令来安装 swaggo： ``` go get -u github.com/swaggo/swag/cmd/swag ``` 2. 在你...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

xvwen

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值