go语⾔⽣成markdown⽂档⼯具
虽然有go语⾔的swagger，但是go版本的swagger对代码的侵⼊⽐较⼤，因此抽空实现了基于GO语⾔⽣成markdown⽂档的⼯具开源链接地址：
gendoc
⽂档⽣成⼯具
MarkDown⽣成说明
⽰例
// doc是字段说明
// 如果是必填項，doc⾥填写 required 即可，注意required前⾯需要加空格
type ReqCreateOrder struct {
Pass      string  `json:"pass" doc:"交易密码不能为空，请⽤BASE64 进⾏转码 required"`
Amount    float32 `json:"amount" doc:"⽀付⾦额，不能⼩于或等于0"`
RandomNum  string  `json:"randomNum" doc:"随机字符串不能为空，最⼤长度为30"`
TranBody  string  `json:"tranBody" doc:"交易描述不能为空，最⼤长度为30；"`
OutTradeNo string  `json:"outTradeNo" doc:"三⽅交易唯⼀订单号，最⼤长度60"`
CreateIp  string  `json:"createIp" doc:"IP地址"`
StartTime  int64  `json:"startTime" doc:"交易开始时间搓，格式为yyyyMMddHHmmss"`
}
type RespCreateOrder struct {
Code int32      `json:"code" doc:"错误码"`
Msg  string      `json:"msg" doc:"错误信息"`
Data interface{} `json:"data" doc:"业务数据"`
}
func TestGenMarkDown(t *testing.T) {
// 实例化⽂档
doc := &gendoc.Document{
Title:  "接⼝⽂档",
Version: "v1.0.0",
BaseUrl: "127.0.0.1:8080",
}
// 添加接⼝
doc.AddItem("创建订单接⼝", "/v1/order/create", gendoc.POST, gendoc.Tomas, &ReqCreateOrder{}, &RespCreateOrder{Data: &ReqCreateOrder{}})
// ⽣成字段
doc.GenerateFields()
// 实例化⽂档⽣成器
md := New(doc)
// ⽣成⽂档
md.Generate("./doc.md")
go语言字符串转数组
}

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。