generator

package
v0.0.0-...-e0fc989 Latest Latest
Warning

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

Go to latest
Published: Mar 29, 2018 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Output

func Output(fullfilename string, content string) error

Output returns file.

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 Frame

type Frame struct {
	// contains filtered or unexported fields
}

Frame faygo app

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

func NewMain

func NewMain(dir string) (*Main, error)

NewMain creates a *Main

func (*Main) AddFrame

func (m *Main) AddFrame(router *Router, frame string, version ...string) error

AddFrame adds faygo app.

func (*Main) Create

func (m *Main) Create() string

Create returns main's codes.

func (*Main) Output

func (m *Main) Output() error

Output returns main's file.

type Node

type Node struct {
	*Router
	// contains filtered or unexported fields
}

Node router tree

func (*Node) Create

func (n *Node) Create() string

Create returns struct handler's codes

type Router

type Router struct {
	// contains filtered or unexported fields
}

Router returns project router codes

func NewRouter

func NewRouter(funcname, dir string) (*Router, error)

NewRouter creates a *Router

func (*Router) AddHandler

func (r *Router) AddHandler(handler Handler) error

AddHandler adds handler.

func (*Router) AddMiddleware

func (r *Router) AddMiddleware(handlers ...Handler) error

AddMiddleware adds midddlerwares.

func (*Router) AddStatic

func (r *Router) AddStatic(name, urlPath string, root string, nocompressAndNocache ...bool) error

AddStatic adds static handler.

func (*Router) Create

func (r *Router) Create() string

Create returns router's codes.

func (*Router) Output

func (r *Router) Output() error

Output returns router's file.

func (*Router) PkgName

func (r *Router) PkgName() string

PkgName returns the package name, e.g `router`

func (*Router) PkgPath

func (r *Router) PkgPath() string

PkgPath returns the package path, e.g `github.com/henrylee2cn/fay/test`

func (*Router) PkgPrefix

func (r *Router) PkgPrefix() string

PkgPrefix returns the package prefix, e.g `router.`

func (*Router) TryMainPkg

func (r *Router) TryMainPkg(mainPkgPath string)

TryMainPkg tries to set it as the main package

type Static

type Static struct {
	Name       string
	UrlPath    string
	Root       string
	Nocompress bool
	Nocache    bool
}

Static static router info

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

Jump to

Keyboard shortcuts

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