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

评论已关闭

推荐阅读

Vue中使用mind-map实现在线思维导图
2024年08月04日
VUE
Web前端最全Vue实现免密登录跳转的方式_vue怎么样不登录返回首页,最强技术实现
2024年08月04日
VUE
vue3 项目搭建教程(基于create-vue,vite,Vite + Vue)
2024年08月04日
VUE
Vue-颜色选择器实现方案——>Vue-Color( 实战*1+ Demo*7)
2024年08月04日
VUE
Vue项目卡顿慢加载?这些优化技巧告诉你!_vue数据多渲染卡顿
2024年08月04日
VUE
vue中的keep-alive详解与应用场景
2024年08月04日
VUE
Vue、React实现excel导出功能(三种实现方式保姆级讲解)
2024年08月04日
vue-office/docx插件实现docx文件预览
2024年08月04日
VUE
java调用js文件的两种方法(支持V8引擎)
2024年08月04日
JavaScript:解决计算精度问题/mathjs/bignumber.js/big.js/decimal.js
2024年08月04日
两周从爬虫小白变大神 _yjs_js_security_passport
2024年08月04日
JS笔记(对象、函数、数组)
2024年08月04日
Markdown.js:强大的纯JavaScript Markdown解析器
2024年08月04日
Vue项目:js模拟点击a标签下载文件并重命名,URL文件地址下载方法、请求接口下载文件方法总结。
2024年08月04日
vue 父组件怎么获取子组件里面的data数据
2024年08月04日
VUE
个人开发实现AI套壳网站快速搭建(Vue+elementUI+SpringBoot)
2024年08月04日
el-table 表格封装并改造实现单元格可编辑
2024年08月04日
none
nodejs环境下创建vue项目、SSH密钥登陆!!!
2024年08月04日
vue+quill+element-ui实现视频、图片上传及缩放保姆级教程,轻松使用富文本
2024年08月04日
【three.js】22. Imported Models导入模型
2024年08月04日