plugin

Documentation

Index

• Constants
• func MergeComments(t *types.Type) []string
• func NewRestPlugin(annotation string, opts ...Opt) *restPlugin
• type AutoFillParamFunc
• type ControllerMarker
  • func (ControllerMarker) Help() *markers.DefinitionHelp
• type GinMetadata
• type Method
• type Opt
  • func SetAutoFillParamFunc(f AutoFillParamFunc) Opt
• type PathVariableMarker
  • func (PathVariableMarker) Help() *markers.DefinitionHelp
• type RequestBodyMarker
  • func (RequestBodyMarker) Help() *markers.DefinitionHelp
• type RequestHeaderMarker
  • func (RequestHeaderMarker) Help() *markers.DefinitionHelp
• type RequestMappingMarker
  • func (RequestMappingMarker) Help() *markers.DefinitionHelp
• type RequestParamMarker
  • func (RequestParamMarker) Help() *markers.DefinitionHelp
• type RequestType
• type TypeMeta

Constants

const (
	RequestTypePath   = "path"
	RequestTypeQuery  = "query"
	RequestTypeHeader = "header"
	RequestTypeBody   = "body"
)

Functions

func MergeComments

func MergeComments(t *types.Type) []string

func NewRestPlugin

func NewRestPlugin(annotation string, opts ...Opt) *restPlugin

Types

type AutoFillParamFunc

type AutoFillParamFunc func(imports namer.ImportTracker, name string, param *types.Type) (*TypeMeta, error)

type ControllerMarker

type ControllerMarker struct {
	Value string `marker:"value,optional"`
}

func (ControllerMarker) Help

func (ControllerMarker) Help() *markers.DefinitionHelp

type GinMetadata

type GinMetadata struct {
	Name           string
	TypeName       string
	Controller     *ControllerMarker
	RequestMapping RequestMappingMarker
	Methods        []*Method
}

type Method

type Method struct {
	Name           string
	Params         []*TypeMeta
	Returns        []*TypeMeta
	RequestMapping RequestMappingMarker
}

type Opt

type Opt func(*restPlugin)

func SetAutoFillParamFunc

func SetAutoFillParamFunc(f AutoFillParamFunc) Opt

type PathVariableMarker

type PathVariableMarker struct {
	Name     string `marker:"name"`
	Default  string `marker:"default,optional"`
	Required bool   `marker:"required,optional"`
}

func (PathVariableMarker) Help

func (PathVariableMarker) Help() *markers.DefinitionHelp

type RequestBodyMarker

type RequestBodyMarker struct {
	markerdefs.Flag `marker:",optional"`
	Name            string `marker:"name"`
	Required        bool   `marker:"required,optional"`
}

func (RequestBodyMarker) Help

func (RequestBodyMarker) Help() *markers.DefinitionHelp

type RequestHeaderMarker

type RequestHeaderMarker struct {
	Name     string `marker:"name"`
	Default  string `marker:"default,optional"`
	Required bool   `marker:"required,optional"`
}

func (RequestHeaderMarker) Help

func (RequestHeaderMarker) Help() *markers.DefinitionHelp

type RequestMappingMarker

type RequestMappingMarker struct {
	markerdefs.Flag `marker:",optional"`
	Value           string `marker:"value,optional"`
	Method          string `marker:"method,optional"`
	Consumes        string `marker:"consumes,optional"`
	Produces        string `marker:"produces,optional"`
}

func (RequestMappingMarker) Help

func (RequestMappingMarker) Help() *markers.DefinitionHelp

type RequestParamMarker

type RequestParamMarker struct {
	Name     string `marker:"name"`
	Default  string `marker:"default,optional"`
	Required bool   `marker:"required,optional"`
}

func (RequestParamMarker) Help

func (RequestParamMarker) Help() *markers.DefinitionHelp

type RequestType

type RequestType string

type TypeMeta

type TypeMeta struct {
	Name        string
	TypeName    string
	Default     string
	Required    bool
	RequestType RequestType
}