web

Documentation

Index

• Constants
• Variables
• type ApiInfo
• type Configure
  • func (c *Configure) Prefix() string
• type Container
• type FS
• type Filter
• type FilterChain
• type FsHandler
• type Param
• type ParamMapper
• type Patterns
• type Rest
• type RestHandler
• type Service
• type ServiceMethod

Constants

const (
	Path      = "path"
	Query     = "query"
	Body      = "body"
	Header    = "header"
	Form      = "form"
	Multipart = "multipart"
	Context   = "context"
	Request   = "request"
	Response  = "response"
	Stream    = "stream"
)

Variables

var (
	MethodDefine = []string{
		http.MethodGet,
		http.MethodHead,
		http.MethodPost,
		http.MethodPut,
		http.MethodPatch,
		http.MethodDelete,
		http.MethodConnect,
		http.MethodOptions,
		http.MethodTrace,
	}
	SourceDefine  = []string{Path, Query, Body, Form, Header, Multipart, Context, Request, Response, Stream}
	DefaultSource = Query
)

Types

type ApiInfo

type ApiInfo struct {
	HttpMethod string
	URL        string
	ApiDesc    string
	Params     []Param
}

type Configure

type Configure struct {
	bean.Component
	Charset string `yaml:"charset"`
}

func (*Configure) Prefix

func (c *Configure) Prefix() string

type Container

type Container interface {
	bean.Bean
	RestHandler() RestHandler
	FsHandler() FsHandler
	ListenAndServe(port int)
}

type FS

type FS struct{}

type Filter

type Filter interface {
	bean.Bean
	Order() int
	UrlPatterns() Patterns
	DoFilter(w http.ResponseWriter, r *http.Request, chain FilterChain) error
}

type FilterChain

type FilterChain interface {
	GetFilter() Filter
	SetNext(chain FilterChain)
	GetNext() FilterChain
	DoFilter(w http.ResponseWriter, r *http.Request) error
	SetService(service Service)
	DoService(w http.ResponseWriter, r *http.Request) error
}

type FsHandler

type FsHandler func(url, dir string)

type Param

type Param struct {
	Name   string
	Source string
	Type   reflect.Type
}

type ParamMapper

type ParamMapper interface {
	//PathParamMapper
	GetStringFromPath(param Param) (string, error)
	GetIntFromPath(param Param) (int, error)
	GetBoolFromPath(param Param) (bool, error)
	GetFloatFromPath(param Param) (float64, error)
	//QueryParamMapper
	GetStringFromQuery(param Param) (string, error)
	GetIntFromQuery(param Param) (int, error)
	GetBoolFromQuery(param Param) (bool, error)
	GetFloatFromQuery(param Param) (float64, error)
	GetStructFromQuery(param Param) (interface{}, error)
	//BodyParamMapper
	GetStructFromBody(param Param) (interface{}, error)
	GetMapFromBody(param Param) (interface{}, error)
	//HeaderParamMapper
	GetStringFromHeader(param Param) (string, error)
	//FormParamMapper
	GetStringFromForm(param Param) (string, error)
	GetIntFromForm(param Param) (int, error)
	GetBoolFromForm(param Param) (bool, error)
	GetFloatFromForm(param Param) (float64, error)
	GetMapFromForm() (map[string][]string, error)
	//UploadMapper
	GetStringFromMultipart(param Param) (string, error)
	GetMultipartHeader(param Param) (*multipart.FileHeader, error)
	GetMultipartFile(param Param) (multipart.File, error)
	GetStream() ([]byte, error)
	//HttpMapper
	GetRequest() (*http.Request, error)
	GetResponseWriter() (http.ResponseWriter, error)
	//Context
	GetContext() (context.Context, error)
	//ExtendedParamMapper
	Get(param Param) (interface{}, error)
}

type Patterns

type Patterns []string

type Rest

type Rest struct{}

type RestHandler

type RestHandler func(apiInfo *ApiInfo, svm *ServiceMethod)

type Service

type Service func(w http.ResponseWriter, r *http.Request) error

type ServiceMethod

type ServiceMethod struct {
	Type  *reflect.Method
	Value *reflect.Value
}