golang 引入swagger(iris、gin)

在Go中使用Swagger需要使用Swagger 2.0规范来描述API。可以使用swag工具自动生成Swagger文档。以下是一个使用iris框架和swag的例子:

首先,安装swag工具:




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

确保你的项目中已经安装了iris框架:




go get -u github.com/kataras/iris

然后,安装swag的iris中间件:




go get -u github.com/swaggo/iris

接下来,定义你的API以及它们的Swagger注释。例如:




package main
 
import (
    "github.com/kataras/iris"
    "github.com/swaggo/files"
    "github.com/swaggo/iris/swagger"
)
 
// @title Swagger Example API
// @version 1.0
// @description This is a sample server Petstore server.
// @termsOfService http://swagger.io/terms/
// @contact.name API Support
// @contact.url http://www.swagger.io/support
// @contact.email support@swagger.io
// @license.name Apache 2.0
// @license.url http://www.apache.org/licenses/LICENSE-2.0.html
// @host petstore.swagger.io
// @BasePath /v2
func main() {
    iris.Get("/swagger", swagger.WrapHandler(swagger.URL("http://localhost:8080/swagger/swagger.json")))
 
    iris.Listen(":8080")
}

在你的代码中添加注释,并且运行swag init来生成Swagger文档:




swag init -g main.go

这将会在你的项目目录下创建一个docs文件夹,里面包含了Swagger的JSON和HTML文件。

最后,在你的iris服务中加入Swagger中间件,以便可以在浏览器中查看和测试你的API:




iris.Get("/swagger", swagger.WrapHandler(swagger.URL("http://localhost:8080/swagger/swagger.json")))

现在,当你运行你的服务并访问http://localhost:8080/swagger/时,你应该能够看到Swagger UI,它展示了你的API文档。

最后修改于:2024年08月15日 14:01

评论已关闭

推荐阅读

DDPG 模型解析,附Pytorch完整代码
2024年11月24日
DQN 模型解析,附Pytorch完整代码
2024年11月24日
AIGC实战——Transformer模型
2024年12月01日
Socket TCP 和 UDP 编程基础(Python)
2024年11月30日
python , tcp , udp
如何使用 ChatGPT 进行学术润色?你需要这些指令
2024年12月01日
AI
最新 Python 调用 OpenAi 详细教程实现问答、图像合成、图像理解、语音合成、语音识别(详细教程)
2024年11月24日
ChatGPT 和 DALL·E 2 配合生成故事绘本
2024年12月01日
omegaconf,一个超强的 Python 库!
2024年11月24日
【视觉AIGC识别】误差特征、人脸伪造检测、其他类型假图检测
2024年12月01日
[超级详细]如何在深度学习训练模型过程中使用 GPU 加速
2024年11月29日
Python 物理引擎pymunk最完整教程
2024年11月27日
MediaPipe 人体姿态与手指关键点检测教程
2024年11月27日
深入了解 Taipy:Python 打造 Web 应用的全面教程
2024年11月26日
基于Transformer的时间序列预测模型
2024年11月25日
Python在金融大数据分析中的AI应用(股价分析、量化交易)实战
2024年11月25日
AIGC Gradio系列学习教程之Components
2024年12月01日
Python3 `asyncio` — 异步 I/O,事件循环和并发工具
2024年11月30日
llama-factory SFT系列教程:大模型在自定义数据集 LoRA 训练与部署
2024年12月01日
Python 多线程和多进程用法
2024年11月24日
Python socket详解,全网最全教程
2024年11月27日