api

package module
v0.24.1 Latest Latest
Warning

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

 Go to latest Published: Mar 21, 2025 License: MIT Imports: 21 Imported by: 8

README

api-server

Documentation

Index

Constants

View Source 
const (
	MethodGet  string = fasthttp.MethodGet
	MethodPost string = fasthttp.MethodPost

	StatusBadRequest   = fasthttp.StatusBadRequest
	StatusUnauthorized = fasthttp.StatusUnauthorized
	StatusForbidden    = fasthttp.StatusForbidden
	StatusNotFound     = fasthttp.StatusNotFound
	StatusOK           = fasthttp.StatusOK

	StatusInternalServerError = fasthttp.StatusInternalServerError
	StatusServiceUnavailable  = fasthttp.StatusServiceUnavailable

	StatusBadGateway = fasthttp.StatusBadGateway
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Action 

type Action interface {
	AssignTo(prop string) Action
	// contains filtered or unexported methods
}

Action ...

type Context 

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

func (*Context) ContentType added in v0.7.0 

func (c *Context) ContentType() string

func (*Context) Database added in v0.11.2 

func (c *Context) Database() (*dbm.Connection, error)

func (*Context) Error added in v0.7.0 

func (c *Context) Error(code int, msg string) error

func (*Context) GetValue added in v0.5.1 

func (c *Context) GetValue(name string) interface{}

func (*Context) Method added in v0.7.0 

func (c *Context) Method() string

func (*Context) Redirect added in v0.7.5 

func (c *Context) Redirect(url string) error

func (*Context) RemoteIP added in v0.7.2 

func (c *Context) RemoteIP() string

func (*Context) Request 

func (c *Context) Request() *Request

func (*Context) RequiredParams added in v0.11.0 

func (c *Context) RequiredParams(names string) (json.Object, error)

func (*Context) Response 

func (c *Context) Response() *Response

func (*Context) Session 

func (c *Context) Session() *Session

Session ..

func (*Context) SetValue added in v0.5.1 

func (c *Context) SetValue(name string, value interface{})

func (*Context) Status added in v0.7.0 

func (c *Context) Status(code int, msg string) error

func (*Context) StatusBadRequest added in v0.7.0 

func (c *Context) StatusBadRequest(msg string) error

func (*Context) StatusForbidden added in v0.7.0 

func (c *Context) StatusForbidden(msg string) error

func (*Context) StatusInternalServerError added in v0.7.0 

func (c *Context) StatusInternalServerError(msg string) error

func (*Context) StatusNotFound added in v0.7.0 

func (c *Context) StatusNotFound(msg string) error

func (*Context) StatusServiceUnavailable added in v0.7.0 

func (c *Context) StatusServiceUnavailable(msg string) error

func (*Context) StatusUnauthorized added in v0.7.0 

func (c *Context) StatusUnauthorized(msg string) error

func (*Context) Tx 

func (c *Context) Tx() (*dbm.Tx, error)

func (*Context) URL added in v0.7.0 

func (c *Context) URL() *url.URL

func (*Context) Write added in v0.7.0 

func (c *Context) Write(value interface{}) error

func (*Context) WriteBody added in v0.7.0 

func (c *Context) WriteBody(contentType string, body []byte) error

func (*Context) WriteStream added in v0.11.1 

func (c *Context) WriteStream(filename, contentType string, fn func(Writer)) error

type Group added in v0.6.0 

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

Group ..

func (*Group) AddMiddleware added in v0.6.0 

func (g *Group) AddMiddleware(f func(*Context) error) Middleware

func (*Group) Get added in v0.6.1 

func (g *Group) Get(path string) *Route

func (*Group) GetAction added in v0.7.0 

func (g *Group) GetAction(f func(*Context) error) *Route

func (*Group) GetPrefixPath added in v0.24.1 

func (g *Group) GetPrefixPath() string

func (*Group) GetSecureAction added in v0.7.0 

func (g *Group) GetSecureAction(f func(*Context) error) *Route

func (*Group) HandleWebsocket added in v0.17.0 

func (g *Group) HandleWebsocket(path string) *Websocket

func (*Group) Post added in v0.6.0 

func (g *Group) Post(path string) *Route

func (*Group) PostAction added in v0.7.0 

func (g *Group) PostAction(f func(*Context) error) *Route

func (*Group) PostSecureAction added in v0.7.0 

func (g *Group) PostSecureAction(f func(*Context) error) *Route

func (*Group) RemoveRoute added in v0.20.0 

func (g *Group) RemoveRoute(method, path string)

func (*Group) SetPrefixPath added in v0.16.1 

func (g *Group) SetPrefixPath(path string)

type Middleware 

type Middleware interface {
	//ForGroup set name for this middleware, this middleware only used by route that requiring the same name
	ForGroup(string) Middleware
	Secure() Middleware
}

Middleware ..

type Proxy added in v0.16.0 

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

func (*Proxy) Rewrite added in v0.16.0 

func (p *Proxy) Rewrite(regexPath, replacePath string) (*Proxy, error)

type Render added in v0.7.1 

type Render func(*Context) bool

type Request 

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

func (*Request) Body added in v0.5.1 

func (r *Request) Body() []byte

func (*Request) File added in v0.11.1 

func (r *Request) File(name string) (*multipart.FileHeader, error)

func (*Request) Form added in v0.23.1 

func (r *Request) Form() (*multipart.Form, error)

func (*Request) Header 

func (r *Request) Header() *RequestHeader

func (*Request) JSON added in v0.5.0 

func (r *Request) JSON() json.Object

func (*Request) Method added in v0.5.0 

func (r *Request) Method() string

func (*Request) QueryParam added in v0.11.1 

func (r *Request) QueryParam(name string) string

func (*Request) URL added in v0.4.0 

func (r *Request) URL() *url.URL

func (*Request) ValidJSON added in v0.15.4 

func (r *Request) ValidJSON(names ...string) (json.Object, error)

type RequestHeader added in v0.5.0 

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

func (*RequestHeader) Bytes added in v0.6.0 

func (r *RequestHeader) Bytes() []byte

func (*RequestHeader) Cookie added in v0.15.0 

func (r *RequestHeader) Cookie(key string) string

func (*RequestHeader) Get added in v0.5.0 

func (r *RequestHeader) Get(key string) string

type Response 

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

func (*Response) Body 

func (r *Response) Body() []byte

func (*Response) ContentType added in v0.5.0 

func (r *Response) ContentType() string

func (*Response) Data added in v0.7.1 

func (r *Response) Data() json.Object

func (*Response) GetError added in v0.23.12 

func (r *Response) GetError() error

func (*Response) Header 

func (r *Response) Header() *ResponseHeader

func (*Response) Put added in v0.7.5 

func (r *Response) Put(key string, value interface{})

func (*Response) SetContentType added in v0.7.0 

func (r *Response) SetContentType(contentType string)

func (*Response) SetStatusCode added in v0.5.1 

func (r *Response) SetStatusCode(statusCode int)

func (*Response) StatusCode added in v0.7.1 

func (r *Response) StatusCode() int

func (*Response) StatusMessage added in v0.7.1 

func (r *Response) StatusMessage() string

type ResponseHeader added in v0.5.1 

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

func (*ResponseHeader) Add added in v0.5.1 

func (r *ResponseHeader) Add(key, value string)

func (*ResponseHeader) Del added in v0.23.6 

func (r *ResponseHeader) Del(key string)

func (*ResponseHeader) Get added in v0.7.0 

func (r *ResponseHeader) Get(key string) string

func (*ResponseHeader) Set added in v0.5.1 

func (r *ResponseHeader) Set(key, value string)

func (*ResponseHeader) SetCookie added in v0.7.0 

func (r *ResponseHeader) SetCookie(key, value string, expireIn time.Duration)

type Route 

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

Route ...

func (*Route) AddAction added in v0.7.0 

func (r *Route) AddAction(f func(*Context) error) Action

func (*Route) AddQueryAction 

func (r *Route) AddQueryAction(query, params string) Action

AddQueryAction ...

func (*Route) ResetActions added in v0.17.4 

func (r *Route) ResetActions() *Route

func (*Route) Secure added in v0.6.0 

func (r *Route) Secure() *Route

Secure ...

func (*Route) UseGroup added in v0.6.0 

func (r *Route) UseGroup(name string) *Route

UseGroup only use middleware that have the same name or no name

type Server 

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

func New added in v0.3.1 

func New(opts ...ServerOptions) *Server

New ...

func (*Server) AddMiddleware 

func (s *Server) AddMiddleware(f func(*Context) error) Middleware

AddMiddleware ..

func (*Server) AddProxy added in v0.16.0 

func (s *Server) AddProxy(address string) *Proxy

func (*Server) Connect 

func (s *Server) Connect() error

Connect ...

func (*Server) Database 

func (s *Server) Database() *dbm.Connection

Database ...

func (*Server) FileRoute added in v0.4.0 

func (s *Server) FileRoute(path, dest, redirectTo string) error

FileRoute serve static file. Path parameter to determine url to be processed. Dest parameter will find directory of the file reside. RedirectTo parameter to redirect non existing file, this param can be used for SPA (ex. index.html).

func (*Server) FileRouteRemove added in v0.4.1 

func (s *Server) FileRouteRemove(path string) error

FileRouteRemove ...

func (*Server) Get added in v0.6.1 

func (s *Server) Get(path string) *Route

func (*Server) GetAction added in v0.10.5 

func (s *Server) GetAction(f func(*Context) error) *Route

func (*Server) Group added in v0.6.0 

func (s *Server) Group(name string) *Group

if name is empty will return default group

func (*Server) HandleWebsocket added in v0.17.1 

func (s *Server) HandleWebsocket(path string) *Websocket

func (*Server) HasGroup added in v0.16.1 

func (s *Server) HasGroup(name string) bool

func (*Server) MaxRequestSize added in v0.11.1 

func (s *Server) MaxRequestSize(size int)

func (*Server) NormalizeFunc added in v0.3.2 

func (s *Server) NormalizeFunc(n bool)

NormalizeFunc this func need to called before adding any routes. parameter n=true for renaming all route paths to lowercase, separated with underscore. Ex: /HelloWorld registered as /hello_world

func (*Server) OpenDatabase 

func (s *Server) OpenDatabase(driver, host string, port int, username, password, name string) error

OpenDatabase ..

func (*Server) Post added in v0.6.0 

func (s *Server) Post(path string) *Route

func (*Server) PostAction added in v0.7.0 

func (s *Server) PostAction(f func(*Context) error) *Route

func (*Server) PostSecureAction added in v0.7.0 

func (s *Server) PostSecureAction(f func(*Context) error) *Route

func (*Server) RemoveRoute added in v0.21.2 

func (s *Server) RemoveRoute(method, path string)

func (*Server) Serve 

func (s *Server) Serve(port int) error

Serve ..

func (*Server) ServeUnix added in v0.12.0 

func (s *Server) ServeUnix(filename string) error

func (*Server) SetDatabase 

func (s *Server) SetDatabase(cn *dbm.Connection)

func (*Server) SetLogger 

func (s *Server) SetLogger(debug func(...interface{}), info func(...interface{}), warn func(...interface{}), err func(...interface{}))

SetLogger ...

func (*Server) SetRender added in v0.7.1 

func (s *Server) SetRender(r Render)

func (*Server) Shutdown added in v0.5.1 

func (s *Server) Shutdown() error

Shutdown ..

type ServerOptions added in v0.21.0 

type ServerOptions func(*Server)

func OptionTimeout added in v0.21.0 

func OptionTimeout(timeout time.Duration) ServerOptions

type Session 

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

func (*Session) Get 

func (s *Session) Get(key string) interface{}

func (*Session) GetInt added in v0.4.0 

func (s *Session) GetInt(key string) int

func (*Session) GetString 

func (s *Session) GetString(key string) string

func (*Session) Put 

func (s *Session) Put(key string, value interface{})

func (*Session) Remove added in v0.6.0 

func (s *Session) Remove(key string)

type Websocket added in v0.17.0 

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

func (*Websocket) OnAccept added in v0.17.1 

func (w *Websocket) OnAccept(fn func(client *websocket.Client)) *Websocket

type Writer added in v0.17.1 

type Writer interface {
	//Write data, return length has been written and errors if any
	Write(data []byte) (int, error)
	Flush() error
	Close() error
}

Source Files

View all Source files

Directories

Path Synopsis
examples
helloworld
secure

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.