web

Documentation

Index

• Constants
• Variables
• type ApiInfo
• type Configure
• type Controller
• type Endpoint
• type FS
• type FeignClient
• type Filter
• type FilterChain
• type FsController
• type Param
• type ParamAdapter
• type RestMethod
• type Server
• 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 (
	SourceDefine  = []string{Path, Query, Body, Form, Header, Multipart, Context, Request, Response, Stream}
	DefaultSource = Query
)

Types

type ApiInfo

type ApiInfo interface {
	GetHttpMethod() string
	GetURL() string
	GetDescription() string
	GetParams() []Param
	GetField() reflect.StructField
	GetMethodName() string
	GetMeta(tag string) string
}

type Configure

type Configure struct {
	types.AutoConfigure `prefix:"application.web"`
	Charset             string `yaml:"charset"`
}

type Controller

type Controller interface {
	bean.Bean
	Group() string
}

Controller web restful api controller

type Endpoint

type Endpoint interface {
	GetApiInfo() ApiInfo
	GetServiceMethod() ServiceMethod
	Handler(adapter ParamAdapter, handler func(result interface{}) error)
}

type FS

type FS struct{}

FS is file system mapping

type FeignClient

type FeignClient interface {
	bean.Bean
	Name() string
	Url() string
	Path() string
}

type Filter

type Filter interface {
	bean.Bean
	Order() int
	UrlPatterns() []string
	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() error
}

type FsController

type FsController interface {
	Controller
	Compile() bool
}

FsController static assets controller

type Param

type Param interface {
	GetName() string
	GetSource() string
	GetSpecifyType() string
	GetType() reflect.Type
	SetType(t reflect.Type)
}

type ParamAdapter

type ParamAdapter interface {
	GetStringFromPath(name string) (string, error)
	GetRequest() *http.Request
	GetResponseWriter() http.ResponseWriter
}

type RestMethod

type RestMethod interface {
	GetType() string
}

RestMethod is restful mapping interface

type Server

type Server interface {
	bean.Bean
	RegisterEndpoint(endpoint Endpoint)
	FsHandler(prefix, dir string)
	ListenAndServe(port int) error
}

Server web server container

type Service

type Service func() error

type ServiceMethod

type ServiceMethod interface {
	GetMethod() *reflect.Method
	GetValue() *reflect.Value
}