autodoc

package

v0.0.0-...-a4d5418 Latest Latest Go to latest Published: Dec 3, 2019 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

自动化文档

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 struct {
	Field     string //字段
	FieldType string //字段类型
	Required  bool   //必填字段
	Desc      string //字段说明
}

请求参数