所以，希望能有工具能自动将代码中的对象或注释信息生成API文档。本文接下来将介绍两个工具来解决上述中的问题： Swagger Swagger是一个简单但功能强大的API表达工具。...使用Swagger生成API，我们可以得到交互式文档，自动生成代码的SDK以及API的发现特性等。 swaggo swaggo是一个用于将golang注解自动转换为Swagger 2.0文档的工具。...从上面的介绍中可知，结合Swagger和swaggo这两个工具，我们可以做到： 自动生成API文档； 生成的文档是可交互的，甚至在文档页面上完成自测。...0x03 推荐阅读 下面是一些推荐阅读的链接，大家可以进一步进行阅读： 五分钟理解golang的init函数 How to Write Go Code 使用go-swagger为golang API自动生成...swagger文档 使用swaggo自动生成Restful API文档
是一个工具，专门用于将 golang 注解自动转换为Swagger 2.0文档 Swagger 又是个啥？...大致有如下 2 个优势： 支持 API 自动生成同步的在线文档 使用 Swagger 后可以直接通过代码生成文档，不再需要自己手动编写接口文档了 提供了 Web 页面在线测试 API Swagger 生成的文档还支持在线测试...咱们如何使用 swaggo？...咱们来写一个最基本你的swaggo的案例使用，大致分为如下步骤： 安装swag，用于自动生成文档 go get -u github.com/swaggo/swag/cmd/swag 需要使用到如下...比较方便，之前也和大家分享过gin 的使用，感兴趣的可以查看文章 Gin实战演练 go get github.com/swaggo/gin-swagger 第二个是swagger 内置文件 go get
使用GIN（后台回复Golang梦工厂：gin，可获取2020GIN中文文档）作为web框架，使用jwt进行身份校验，使用swagger生成接口文档。...swagger可以减少我们的工作量，直接生成API文档，减少了文档编写的工作。我们先来看一看swagger的生态使用图： 红色字是官方推荐的。...swagger-editor：就是一个在线编辑文档说明文件（swagger.json或swagger.yaml文件）的工具，以方便生态中的其他小工具（swagger-ui）等使用 swagger-codegen...或者参考这篇文章：https://razeencheng.com/post/go-swagger 2.1 项目中使用swagger 安装swag $ go get -u github.com/swaggo...v1.6.7 安装gin-swagger $ go get -u github.com/swaggo/gin-swagger $ go get -u github.com/swaggo/gin-swagger
生成的 docs 包 注册 Gin router 5.FAQ 参考文献 1.背景 后台服务通过接口（如 RESTful API）对外提供服务时，需要有明确的接口文档。...因此，我们可以采用业界常用的 Swagger 为 RESTful API 生成可交互的接口文档。 本文以 Gin 框架为例，描述 Gin 中如何为接口生成 Swagger 文档。...Swagger UI 他会将我们编写的 OpenAPI 规范呈现为交互式的 API 文档，后文我将使用浏览器来查看并且操作我们的 RESTfulAPI。...使用 Swagger 就是把接口相关信息存储在它定义的描述文件里面（yaml 或 json 格式），再通过维护这个描述文件可以去更新接口文档，以及生成各端代码。...生成 API 描述文件后，便可通过 Swagger 为我们提供的库，将 API 描述文件集成到服务中，通过接口的形式提供在线文档。
认证、支持 Swagger 文档(基于swaggo)、基于 GORM 的数据库存储，可扩展多种类型数据库、配置文件简单的模型映射，快速能够得到想要的配置、代码生成工具、表单构建工具、多指令模式、多租户的支持...，使用简单，致力于进行快速的业务研发。...比如，支持 cors 跨域、jwt 签名验证、zap 日志收集、panic 异常捕获、trace 链路追踪、prometheus 监控指标、swagger 文档生成、viper 配置文件解析、gorm...go-gin-api支持 rate 接口限流、支持 panic 异常时邮件通知、支持 cors 接口跨域、支持 Prometheus 指标记录、支持 Swagger 接口文档生成、支持 GraphQL...完整的微信生态覆盖，支持小程序、企业微信、微信支付等模块，公众号(v2版本已经支持)。基于Golang，ArtisanCloud团队在业务基础上开源了Golang版本的WeChatSDK。
可以使用 go install来代替。go install github.com/swaggo/swag/cmd/swag@latest使用用法在你的 API 源代码中添加注释。...go get github.com/hertz-contrib/swaggergo get github.com/swaggo/files并在你的代码中引用如下代码:import "github.com...命令来生成文档，生成的文档将被存储在docs/目录下。...parseDepth100解析依赖包深度，如果你知道解析结构的深度，推荐使用这个参数，swag 命令的执行时间会显著减少。instanceName“swagger”swagger 文档的实例名称。...如果要在一个 Hertz 路由上部署多个不同的 swagger 实例，请确保每个实例有一个唯一的名字。swagger路由配置你可以使用不同的配置选项来配置 Swagger。
Go语言还比较新，所以使用的框架带有充足的文档很重要。 这里有9个框架可帮助你使用Go语言构建项目。...它能够为HTML5模式的AngularJS应用程序执行基本路由，异常处理和默认文档服务。 Martini的最佳功能是可以使用反射，它允许开发人员动态地将数据插入到处理函数中并添加新的服务。...8.带有Vim-Go插件的Vim Vim是一个免费的开源IDE，可以定制和配置各种插件。如果你是Golang程序员，那么你可以使用Vim中由Fatih Arslan创建的vim-go插件。...通过Go-Swagger，你可以swagger规范文档，验证JSON模式以及其他额外的规则。...其他功能包括代码生成，基于swagger规范的API生成，基于代码的规范文档生成，扩展了的字符串格式，等等。
今天的主题：Swagger API 文档 首先问个问题， API 文档重不重要？...路由：包括路径参数、请求参数、还是请求体参数 动作：HTTP 请求动作，GET、POST、DELETE、PUT 响应：请求之后的返回值包含哪些信息，一般是JSON 之前我也写过使用Beego 构建API...beego API 自动化文档的做法是编写注释，注释内包含全局信息或者编写应用注释 今天介绍的是 gin 框架 和 gin-swagger 自动构建 API 文档。...做法 要知道 swagger 注释的语法 如何在 gin 内怎么使用 注释语法这个，全靠查文档。对着文档来。...第四步：导入生成的 docs 文件 import ( "github.com/swaggo/gin-swagger" "github.com/swaggo/gin-swagger/swaggerFiles
2.本项目需要您有一定的golang和vue基础 3.您完全可以通过我们的教程和文档完成一切操作，因此我们不再提供免费的技术服务，如需服务请进行付费支持 4.如果您将此项目用于商业用途，请遵守Apache2.0...自动化API文档 2.3.1 安装 swagger （1）可以访问外国网站 go get -u github.com/swaggo/swag/cmd/swag 复制代码 （2）无法访问外国网站 由于国内没法安装...# 使用如下命令下载swag go get -u github.com/swaggo/swag/cmd/swag 复制代码 2.3.2 生成API文档 cd server swag init 复制代码...:8888/swagger/index.html 即可查看swagger文档 3....API文档：使用Swagger构建自动化文档。 配置文件：使用 fsnotify 和 viper 实现yaml格式的配置文件。 日志：使用 zap 实现日志记录。 4.
[up-030a81d334aadbf6f3c8b1d26885285344c.png] 介绍 本文将介绍如何在 Gin 框架之上提供 Swagger UI。...请访问如下地址获取完整 Gin 教程： https://rkdocs.netlify.app/cn 先决条件 Gin 没有自带生成 Swagger UI 配置文件的功能。...创建 boot.yaml boot.yaml 文件会告诉 rk-boot 如何启动 Gin 服务，下面的例子中，我们指定了端口，Swagger UI 的 json 文件路径。...创建 main.go 为了能让 swag 命令行生成 Swagger UI 参数文件，我们需要在代码中写注释。 详情可参考 swag 官方文档。...生成 swagger 参数文件 默认会在 docs 文件夹里面创建三个文件。rk-boot 会使用 swagger.json 来初始化 Swagger UI 界面。
这篇文章我们讲解swagger的使用 我们在工作当中经常需要用到接口文档，那么怎么写接口文档呢？又会遇到哪些坑呢？刚开始的时候，我们用word写文档，后来我们用markdown写文档。...我在无意当中发现了swagger，从此喜爱上用swagger写文档。他不接可以自动生成文档，而且可以直接用来做接口测试。...首先安装 swagger go get -u github.com/swaggo/swag/cmd/swag go get -u github.com/swaggo/gin-swagger/swaggerFiles..." "github.com/gin-gonic/gin" "github.com/swaggo/gin-swagger" "github.com/swaggo/gin-swagger/swaggerFiles...swagger接口注释解释说明 @Summary 是对该接口的一个描述@Id 是一个全局标识符，所有的接口文档中 Id 不能标注@Tags 是对接口的标注，同一个 tag 为一组，这样方便我们整理接口
[up-1b8cc43bd72d206943de78dde8981bbc1d0.png] 介绍 本文将介绍如何在 GoFrame 框架之上提供 Swagger UI。...boot.yaml 文件会告诉 rk-boot 如何启动 GoFrame 服务，下面的例子中，我们指定了端口，Swagger UI 的 json 文件路径。...UI main page. 2.创建 main.go 为了能让 swag 命令行生成 Swagger UI 参数文件，我们需要在代码中写注释。...详情可参考 swag 官方文档。...rk-boot 会使用 swagger.json 来初始化 Swagger UI 界面。
本篇博客主要介绍了如何从零开始，使用Go Module作为依赖管理，基于Gin来一步一步搭建Go的Web服务器。并使用Endless来使服务器平滑重启，使用Swagger来自动生成Api文档。...引入swagger 完成了基本的框架之后，我们就开始为接口引入swagger文档。写过java的同学应该对swagger不陌生。往常写API文档，都是手写。即每个接口的每一个参数，都需要手打。...而swagger不一样，swagger只需要你在接口上打上几个注解（Java中的操作），就可以自动为你生成swagger文档。...在项目根目录下使用swag init命令来初始化swagger文档。.../index.html就可以看到swagger根据注释自动生成的API文档了。
[up-f19b38fb8d246c169a047b9f78ef7591048.png] 介绍 本文将介绍如何在 Echo 框架之上提供 Swagger UI。...boot.yaml 文件会告诉 rk-boot 如何启动 Echo 服务，下面的例子中，我们指定了端口，Swagger UI 的 json 文件路径。...UI main page. 2.创建 main.go 为了能让 swag 命令行生成 Swagger UI 参数文件，我们需要在代码中写注释。...详情可参考 swag 官方文档。...rk-boot 会使用 swagger.json 来初始化 Swagger UI 界面。
[up-b02d8942b42f4fb017e509152f93d5a6a10.png] 介绍 本文将介绍如何在 gorilla/mux 框架之上提供 Swagger UI。...配置文件的功能。.../mux 服务，下面的例子中，我们指定了端口，Swagger UI 的 json 文件路径。...UI main page. 2.创建 main.go 为了能让 swag 命令行生成 Swagger UI 参数文件，我们需要在代码中写注释。...rk-boot 会使用 swagger.json 来初始化 Swagger UI 界面。
一份清晰明了的接口文档能够极大地提高前后端双方的沟通效率和开发效率。本文将介绍如何使用swagger生成接口文档。...注：OpenAPI规范的介绍引用自原文 swagger生成接口文档 swagger介绍 Swagger本质上是一种用于描述使用JSON表示的RESTful API的接口描述语言。...在前后端分离的项目开发过程中，如果后端同学能够提供一份清晰明了的接口文档，那么就能极大地提高大家的沟通效率和开发效率。可是编写接口文档历来都是令人头痛的，而且后续接口文档的维护也十分耗费精力。...使用swag工具扫描代码自动生成API接口文档数据 使用gin-swagger渲染在线接口文档页面 第一步：添加注释 在程序入口main函数上以注释的方式写下项目相关介绍信息。...编写完注释后，使用以下命令安装swag工具： go get -u github.com/swaggo/swag/cmd/swag 在项目根目录执行以下命令，使用swag工具生成接口文档数据。
因为别人的项目，可能是经历很长时间，花了大量时间辛辛苦苦维护的，你千万别想着花一两个小时就能完全看懂了，还是要有点耐心的。 当然，如果你是万中无一的绝世高手，那么就随意啦！...gin-vue-admin 是一个使用 gin + vue 进行极速开发的全栈后台管理系统，后台使用 gin 框架，gin 是目前很流行的 Go 语言 web 框架，前端主要使用 vue。...这个项目还有详细的中文文档，并且配套教学视频，值得学习！...、跨域、访问日志、追踪ID等） 基于 Casbin 的 RBAC 访问控制模型 JWT 认证 支持 Swagger 文档(基于 swaggo) 基于 GORM 的数据库存储，可扩展多种类型数据库 配置文件简单的模型映射...6、7days-golang Github 地址：https://github.com/geektutu/7days-golang Star 数量：7k 这是一个七天从零用 Go 实现简易版项目的系列，
后来找来找去花了将近一周的时间，找遍了一系列的开源项目的网站最终还是被我翻到了这个前后端分离的权限管理系统，虽说和自己的语言不对口，但是研究研究终归很多地方能借用上的。...框架，提供了丰富的中间件支持（用户认证、跨域、访问日志、追踪ID等），Casbin的 RBAC 访问控制模型，带有JWT 认证，支持 Swagger 文档(基于swaggo)，基于 GORM 的数据库存储...字典管理：对系统中经常使用的一些较为固定的数据进行维护。 参数管理：对系统动态配置常用参数。 操作日志：系统正常操作日志记录和查询；系统异常信息日志记录和查询。...系统接口：根据业务代码自动生成相关的api接口文档。 看看详细： ? ? ? ? ? ? ?...好了图片就展示这么多了，不要看这个小小的系统，也使用了很多开源项目比如： 1.Gin Web Framework 2.Casbin 3.spf13/viper 4.GORM 5.gin-swagger
GO的定时器Timer 和定时任务cron 上次我们说到了GO 中 swaggo 的应用，咱们来回顾一下 swaggo 是什么 swagger 是什么 如何使用 swaggo 如何测试 swaggo...要是对GO 中 swaggo 的应用还有点兴趣的话，可以查看文章 工作中后端是如何将API提供出去的？...swaggo很不错 之后我们可以来一次 swaggo 的原理分享，细细的了解一下swaggo是如何生成swagger 文档的 今天咱们来看看 GO 里面的 **定时器 Timer 和 定时任务 cron...咱们创建的 time.Timer ，实际上就是在这个最小堆中添加一个 timer 对象实例，那么我们需要停止定时器，也就是使用 timer.Stop的时候，就是从这个堆里面删除对应的 timer 对象...} 咱们分别从如下几个场景使用一下 Timer 基本使用 Time 延时使用 停止定时器 重置定时器 基本使用 咱们设置一个 1s 中的定时器，这个定时器只会触发一次 创建一个定时器： func New
架构图大概如下： 拿到需求后，结合团队内部熟悉的技术栈，我们确定了后台服务【业务逻辑层】使用 Golang 语言来开发，用到的框架有 Gin 来做 HTTP 交互，Swaggo 自动生成接口文档，Redis...error 是一个接口类型，定义如下： type error interface { Error() string } error 的使用在代码中随处可见，比如：数据库三方包 Gorm...模块说明 模块 说明 1**** 1开头为服务级错误码，如服务内部错误，参数信息有误等 2**** 2开头：业务模块级错误码 201** 201开头为数据集模块的错误码 202** 202：用户管理模块...接下来，我们用一个用户注册的接口来简单示范下使用方式。.../gin-swagger v1.6.0 github.com/swaggo/swag v1.16.1 go.uber.org/zap v1.25.0 golang.org/x/arch
领取专属 10元无门槛券
手把手带您无忧上云
云服务器
ICP备案
对象存储
实时音视频
即时通信 IM
