gdoc

Documentation

Index

• func NewDoc(group string) *model
• type DocModel
• type ElementInfo
• type StructInfo

Functions

func NewDoc

func NewDoc(group string) *model

NewDoc 新建一个doc模板

Types

type DocModel

type DocModel struct {
	RouterPath string
	Methods    []string
	Note       string
	Req, Resp  *StructInfo
}

DocModel model

type ElementInfo

type ElementInfo struct {
	Name string // 参数名
	// URL      string      // web 访问参数
	Tag      string      // 标签
	Type     string      // 类型
	TypeRef  *StructInfo // 类型定义
	IsArray  bool        // 是否是数组
	Required bool        // 是否必须
	Note     string      // 注释
	Default  string      // 默认值
}

ElementInfo 结构信息

type StructInfo

type StructInfo struct {
	Items []ElementInfo // 结构体元素
	Note  string        // 注释
	Name  string        //结构体名字
	Pkg   string        // 包名
}

StructInfo struct define