mindoc

package
v0.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 20, 2022 License: MIT Imports: 0 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Api

type Api struct {
	Index               int
	Name                string
	Desc                string
	Method              string
	RoutePath           string
	Params              []Param
	Resps               []Resp
	BodyExample         string
	SuccessExampleJson  string
	FailedExampleJson   string
	RequestExampleCode  string
	ResponseExampleCode string
}

type Param

type Param struct {
	Name          string
	Optional      bool
	OptionalText  string
	Default       string
	ParamType     string
	ParamLocation string
	Desc          string
}

type Resp

type Resp struct {
	Name      string
	ParamType string
	Desc      string
}

type Root

type Root struct {
	Title   string   //服务标题
	BaseURL string   //基本url
	BaseApi string   //基本path
	Scheme  string   //http(s)
	Descs   []string //描述
	Apis    []Api    //apis
	Footers []string //附
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL