types

Documentation

Index

• Constants
• type Option
• type Renderer
• type Swagger

Constants

const (
	JsonTagKey        = "json"
	FormTagKey        = "form"
	PathTagKey        = "path"
	HeaderTagKey      = "header"
	DefaultSummaryKey = "summary"
)

Go zero defined tag keys.

Types

type Option

type Option struct {
	Host          string
	BasePath      string
	Schemes       []string
	RenderType    string
	Version       string
	Target        string
	TagPrefix     string
	OutsideSchema string
	ResponseKey   string
}

type Renderer

type Renderer interface {
	Render(plg *plugin.Plugin, opt Option) (Swagger, error)
}

type Swagger

type Swagger interface {
	EncodeJSON() ([]byte, error)
	EncodeYAML() ([]byte, error)
}