metadata

type ApiCatelog struct {
	Name    string `json:"name,omitempty"`    // API 方法名
	Tips    string `json:"tips,omitempty"`    // tips
	SubName string `json:"subName,omitempty"` // subname
	Id      int64  `json:"id,omitempty"`      // API ID
	DocId   int64  `json:"docId,omitempty"`   // API 文档ID
	DocType int    `json:"docType,omitempty"` // API 文档类型
}

type ApiCatelogData struct {
	TreeCategories []ApiTreeCategory `json:"treeCategories,omitempty"` // 类目树列表
	Name           string            `json:"name,omitempty"`           // 名称
	Id             int64             `json:"id,omitempty"`             // ID
}

type ApiCatelogResponse struct {
	Data    ApiCatelogData `json:"data,omitempty"`    // 返回成功数据
	Code    string         `json:"code,omitempty"`    // 错误代码
	ErrMsg  string         `json:"errMsg,omitempty"`  // 错误信息
	Success bool           `json:"success,omitempty"` // 是否成功
}

type ApiCatelogTree struct {
	CatelogList []ApiCatelog `json:"catelogList,omitempty"` // API列表
	Name        string       `json:"name,omitempty"`        // 类目名
	Id          int64        `json:"id,omitempty"`          // 类目ID
}

type ApiDoc struct {
	RequestParams  []ApiParam `json:"requestParams,omitempty"`  // 请求参数
	ResponseParams []ApiParam `json:"responseParams,omitempty"` // 返回参数
	Name           string     `json:"name,omitempty"`           // API 方法名
	ChineseName    string     `json:"apiChineseName,omitempty"` // API 中文名
	Description    string     `json:"description,omitempty"`    // API 描述
	Id             int64      `json:"id,omitempty"`             // API ID
}

type ApiDocResponse struct {
	Data    ApiDoc `json:"data,omitempty"`    // 成功数据
	Code    string `json:"code,omitempty"`    // 错误代码
	ErrMsg  string `json:"errMsg,omitempty"`  // 错误信息
	Success bool   `json:"success,omitempty"` // 是否成功
}

type ApiParam struct {
	SubParams   []ApiParam   `json:"subParams,omitempty"`   // 对象包含参数
	Name        string       `json:"name,omitempty"`        // 参数名
	Type        ApiParamType `json:"type,omitempty"`        // 参数类型
	Description string       `json:"description,omitempty"` // 描述
	MaxLength   json.Number  `json:"maxLength,omitempty"`   // 最大长度
	MaxListSize json.Number  `json:"maxListSize,omitempty"` // 列表最大数量
	MaxValue    json.Number  `json:"maxValue,omitempty"`    // 最大值
	MinValue    json.Number  `json:"minValue,omitempty"`    // 最小值
	Required    bool         `json:"required,omitempty"`    // 是否必须
	UsePointer  bool         `json:"use_pointer,omitempty"` // 生成SDK是否使用指针
}

type ApiParamType = string

type ApiTpl struct {
	RequestParams  []TplParam // 请求参数
	ResponseParams []TplParam // 返回参数
	Pkg            string     // 包名
	ApiName        string     // Api方法名
	Name           string     // Api结构体名
	ResponseKey    string     // ***_response
	SnakeName      string     // snake 化方法名
	ChineseName    string     // 中文名
	Desc           string     // 描述
	IsMultipart    bool       // 是否使用multipart/form
	HasRequestId   bool       // 返回参数中是否已包含RequestId
}

type ApiTreeCategory struct {
	CatelogTrees []ApiCatelogTree `json:"catelogTrees,omitempty"` // 类目列表
	Name         string           `json:"name,omitempty"`         // api catelog tree name
	Id           int64            `json:"id,omitempty"`           // api catelog tree id
}

type PkgConfig struct {
	Name string `json:"name,omitempty"` // api catelog name
	Pkg  string `json:"pkg,omitempty"`  // go package name
	Id   int64  `json:"id,omitempty"`   // api catelog id
}

type PkgConfigSlice []PkgConfig

type TplModel struct {
	Params      []TplParam // struct 成员
	Pkg         string     // 包名
	Name        string     // struct 名
	ImportModel bool       // 是否import github.com/bububa/opentaobao/model
}

type TplParam struct {
	Obj       []TplParam // 对象类型结构体参数
	Name      string     // 结构体成员名
	Label     string     // 第一个字母小写的
	ParamKey  string     // api 参数的key(json/xml)
	Type      string     // 参数类型
	ObjType   string     // 对象类型的对象名
	SnakeType string     // 对象类型名snake化
	Desc      string     // 描述
	IsObject  bool       // 是否是对象
	IsList    bool       // 是否是数组
	IsNumber  bool       // 是否是说字
	IsBool    bool       // 是否是布尔
	Required  bool       // 是否必须
}