go swagger API文档生成工具使用

Go 常用工具之swagger



前言


一、结构体注释规范

type detailResponse struct {
Name string json:"name" // 任务名称
Spec string json:"spec" // crontab 表达式
Command string json:"command" // 执行命令
Protocol int32 json:"protocol" // 执行方式 1:shell 2:http
HttpMethod int32 json:"http_method" // http 请求方式 1:get 2:post
Timeout int32 json:"timeout" // 超时时间(单位:秒)
RetryTimes int32 json:"retry_times" // 重试次数
RetryInterval int32 json:"retry_interval" // 重试间隔(单位:秒)
NotifyStatus int32 json:"notify_status" // 执行结束是否通知 1:不通知 2:失败通知 3:结束通知 4:结果关键字匹配通知
NotifyType int32 json:"notify_type" // 通知类型 1:邮件 2:webhook
NotifyReceiverEmail string json:"notify_receiver_email" // 通知者邮箱地址(多个用,分割)
NotifyKeyword string json:"notify_keyword" // 通知匹配关键字(多个用,分割)
Remark string json:"remark" // 备注
IsUsed int32 json:"is_used" // 是否启用 1:是 -1:否
}

二、接口和函数实现规范

type Handler interface {	 
		// HashIdsEncode HashIds 加密
		// @Tags API.tool
		// @Router /api/tool/hashids/encode/{id} [get]
		HashIdsEncode() core.HandlerFunc
	}

如果我的内容能帮上你是我的荣幸,如果能打赏一下那就是对我最大的鼓励

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

打赏作者

封神梦

各位道友,赏口饭吃吧

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

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

打赏作者

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

抵扣说明:

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

余额充值