Documentation ¶
Index ¶
- func Output(fullfilename string, content string) error
- type Field
- type Frame
- type FuncHandler
- func (s *FuncHandler) Create() (code string, err error)
- func (s *FuncHandler) GetMethod() faygo.Methodset
- func (s *FuncHandler) GetName() string
- func (s *FuncHandler) GetUrlPath() string
- func (s *FuncHandler) Output() error
- func (s *FuncHandler) PkgName() string
- func (s *FuncHandler) PkgPath() string
- func (s *FuncHandler) PkgPrefix() string
- func (s *FuncHandler) RouterName() string
- func (s *FuncHandler) TryMainPkg(mainPkgPath string)
- type Handler
- type Main
- type Node
- type Router
- func (r *Router) AddHandler(handler Handler) error
- func (r *Router) AddMiddleware(handlers ...Handler) error
- func (r *Router) AddStatic(name, urlPath string, root string, nocompressAndNocache ...bool) error
- func (r *Router) Create() string
- func (r *Router) Output() error
- func (r *Router) PkgName() string
- func (r *Router) PkgPath() string
- func (r *Router) PkgPrefix() string
- func (r *Router) TryMainPkg(mainPkgPath string)
- type Static
- type StructHandler
- func (s *StructHandler) Create() (code string, err error)
- func (s *StructHandler) GetMethod() faygo.Methodset
- func (s *StructHandler) GetName() string
- func (s *StructHandler) GetUrlPath() string
- func (s *StructHandler) Output() error
- func (s *StructHandler) PkgName() string
- func (s *StructHandler) PkgPath() string
- func (s *StructHandler) PkgPrefix() string
- func (s *StructHandler) RouterName() string
- func (s *StructHandler) TryMainPkg(mainPkgPath string)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Field ¶
type Field struct { Type string // (required) Value type Name string // (required) Field name ParamName string // Param name for API // Default string // Default value for API doc In string // The position of the parameter; if empty, indicates that it is not a request parameter Required bool // Is a required parameter Nonzero bool // Param`s value can not be zero Len string // Length range of param's value Range string // Numerical range of param's value Regexp string // Verify the value of the param with a regular expression(param value can not be null) Maxmb int // When request Content-Type is multipart/form-data, the max memory for body.(multi-param, whichever is greater) Err string // The custom error for binding or validating Desc string // Description OtherTags string // Other tags string // contains filtered or unexported fields }
Field struct handler's field
type FuncHandler ¶
type FuncHandler struct { Dir string // file path or package name UrlPath string // URL's path Name string // (required) struct name Note string // note for API ServeContent string // main logic Return string // response content demo Method faygo.Methodset // contains filtered or unexported fields }
FuncHandler function handler
func (*FuncHandler) Create ¶
func (s *FuncHandler) Create() (code string, err error)
Create returns struct handler's codes
func (*FuncHandler) GetMethod ¶
func (s *FuncHandler) GetMethod() faygo.Methodset
GetMethod returns request method.
func (*FuncHandler) GetName ¶
func (s *FuncHandler) GetName() string
GetName returns handler type name.
func (*FuncHandler) GetUrlPath ¶
func (s *FuncHandler) GetUrlPath() string
GetUrlPath returns router node's url path.
func (*FuncHandler) Output ¶
func (s *FuncHandler) Output() error
Output creates struct handler file.
func (*FuncHandler) PkgName ¶
func (s *FuncHandler) PkgName() string
PkgName returns the package name, e.g `handler`
func (*FuncHandler) PkgPath ¶
func (s *FuncHandler) PkgPath() string
PkgPath returns the package path, e.g `github.com/henrylee2cn/fay/test`
func (*FuncHandler) PkgPrefix ¶
func (s *FuncHandler) PkgPrefix() string
PkgPrefix returns the package name, e.g `handler.`
func (*FuncHandler) RouterName ¶
func (s *FuncHandler) RouterName() string
RouterName returns router node's name
func (*FuncHandler) TryMainPkg ¶
func (s *FuncHandler) TryMainPkg(mainPkgPath string)
TryMainPkg tries to set it as the main package
type Handler ¶
type Handler interface { Output() error TryMainPkg(mainPkgPath string) GetUrlPath() string PkgPath() string PkgPrefix() string RouterName() string GetName() string GetMethod() faygo.Methodset // contains filtered or unexported methods }
Handler interface
type Main ¶
type Main struct {
// contains filtered or unexported fields
}
Main returns project router codes
type Router ¶
type Router struct {
// contains filtered or unexported fields
}
Router returns project router codes
func (*Router) AddHandler ¶
AddHandler adds handler.
func (*Router) AddMiddleware ¶
AddMiddleware adds midddlerwares.
func (*Router) TryMainPkg ¶
TryMainPkg tries to set it as the main package
type StructHandler ¶
type StructHandler struct { Dir string // file path or package name UrlPath string // URL's path Name string // (required) struct name Fields []Field // fields ServeContent string // main logic Note string // note for API Return string // response content demo Method faygo.Methodset // contains filtered or unexported fields }
StructHandler struct handler
func (*StructHandler) Create ¶
func (s *StructHandler) Create() (code string, err error)
Create returns struct handler's codes
func (*StructHandler) GetMethod ¶
func (s *StructHandler) GetMethod() faygo.Methodset
GetMethod returns request method.
func (*StructHandler) GetName ¶
func (s *StructHandler) GetName() string
GetName returns handler type name.
func (*StructHandler) GetUrlPath ¶
func (s *StructHandler) GetUrlPath() string
GetUrlPath returns router node's url path.
func (*StructHandler) Output ¶
func (s *StructHandler) Output() error
Output creates struct handler file.
func (*StructHandler) PkgName ¶
func (s *StructHandler) PkgName() string
PkgName returns the package name, e.g `handler`
func (*StructHandler) PkgPath ¶
func (s *StructHandler) PkgPath() string
PkgPath returns the package path, e.g `github.com/henrylee2cn/fay/test`
func (*StructHandler) PkgPrefix ¶
func (s *StructHandler) PkgPrefix() string
PkgPrefix returns the package name, e.g `handler.`
func (*StructHandler) RouterName ¶
func (s *StructHandler) RouterName() string
RouterName returns router node's name
func (*StructHandler) TryMainPkg ¶
func (s *StructHandler) TryMainPkg(mainPkgPath string)
TryMainPkg tries to set it as the main package