autodoc

Documentation

Index

• type AutoDoc
  • func NewAutoDoc(controllerDir string) *AutoDoc
  • func (this *AutoDoc) Create()
  • func (this *AutoDoc) MakeAutoFile() (err error)
  • func (this *AutoDoc) SetMethod(method string) *AutoDoc
  • func (this *AutoDoc) SetRequest(param interface{}, requiredFields ...string) *AutoDoc
  • func (this *AutoDoc) SetRequestCareField(fields ...string) *AutoDoc
  • func (this *AutoDoc) SetRequestParam(requestParams []RequestParam) *AutoDoc
  • func (this *AutoDoc) SetResponse(param interface{}) *AutoDoc
  • func (this *AutoDoc) SetUrl(url string) *AutoDoc
• type RequestParam

Types

type AutoDoc

type AutoDoc struct {
	// contains filtered or unexported fields
}

自动化文档

func NewAutoDoc

func NewAutoDoc(controllerDir string) *AutoDoc

func (*AutoDoc) Create

func (this *AutoDoc) Create()

临时输出

func (*AutoDoc) MakeAutoFile

func (this *AutoDoc) MakeAutoFile() (err error)

自动生成文档

func (*AutoDoc) SetMethod

func (this *AutoDoc) SetMethod(method string) *AutoDoc

设置请求方式

func (*AutoDoc) SetRequest

func (this *AutoDoc) SetRequest(param interface{}, requiredFields ...string) *AutoDoc

设置请求参数

func (*AutoDoc) SetRequestCareField

func (this *AutoDoc) SetRequestCareField(fields ...string) *AutoDoc

func (*AutoDoc) SetRequestParam

func (this *AutoDoc) SetRequestParam(requestParams []RequestParam) *AutoDoc

设置参数数据

func (*AutoDoc) SetResponse

func (this *AutoDoc) SetResponse(param interface{}) *AutoDoc

设置响应参数

func (*AutoDoc) SetUrl

func (this *AutoDoc) SetUrl(url string) *AutoDoc

设置请求地址

type RequestParam

type RequestParam struct {
	Field     string //字段
	FieldType string //字段类型
	Required  bool   //必填字段
	Desc      string //字段说明
}

请求参数