comment

package

v0.0.0-...-dc5dc8e Latest Latest Go to latest Published: Nov 13, 2021 License: MIT Imports: 6 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 Comment struct {
	// contains filtered or unexported fields
}

Comment

func New(summary, routeBase, routePath, method string) *Comment

func (c *Comment) AddAccept(accept string)

func (c *Comment) AddParam(param Param)

func (c *Comment) AddProduce(prod string)

func (c *Comment) AddResp(resp Resp)

func (c *Comment) Decs() []string

Decs common

func (c *Comment) Merge(decl *dst.FuncDecl) bool

func (c *Comment) SetParamRefType(name, refType string)

type Param struct {
	Name     string
	Required bool

	RefType     string
	Description string
	// contains filtered or unexported fields
}

func NewBodyParam(name, refType, desc string) Param

func NewFormDataParam(name, refType, desc string) Param

func NewPathParam(name, refType, desc string) Param

func NewQueryParam(name, refType, desc string) Param

func (p Param) Decs() string

type Params []Param

func (ps Params) Len() int

func (ps Params) Less(i, j int) bool

func (ps Params) Swap(i, j int)

type Resp struct {
	Code int
	Type string
}

func (r Resp) Decs() string

type Route struct {
	RoutePath   string // route path
	RouteMethod string // route method: get post put
}

func (cr Route) Decs() string