api

Documentation

Index

• Constants
• type Api
  • func New(opts ...Option) *Api
  • func NewWithEngine(server *http.Server, engine *gin.Engine, opts ...Option) *Api
  • func (api *Api) ChooseRouter(routerType string, version string) Router
  • func (api *Api) Finish() error
  • func (api *Api) Options() Options
  • func (api *Api) PrefixRouter() Router
  • func (api *Api) RootRouter() Router
  • func (api *Api) Start() error
• type Context
  • func (c *Context) GetAllPathParams() map[string]string
  • func (c *Context) GetAllQueryParams() map[string]string
  • func (c *Context) GetFileHeaderBytes(fileHeader *multipart.FileHeader) (string, []byte, error)
  • func (c *Context) GetHeaders() map[string]string
  • func (c *Context) GetTenantInfo() TenantInfo
  • func (c *Context) GetUserInfo() UserInfo
  • func (c *Context) ReadBody() ([]byte, error)
  • func (c *Context) ReadJsonBody(output any) error
  • func (c *Context) ReplaceBody(body []byte) error
  • func (c *Context) ReplaceJsonBody(body any) error
• type Handler
• type Option
  • func WithPort(port string) Option
  • func WithUrlPrefix(urlPrefix string) Option
• type Options
  • func (options Options) GetPort() string
  • func (options Options) GetUrlPrefix() string
• type PrefixRouter
  • func (r *PrefixRouter) AddMiddlewares(middlewares ...Handler) Router
  • func (r *PrefixRouter) AddRoute(method string, relativePath string, middlewares ...Handler) Router
  • func (r *PrefixRouter) BasePath() string
  • func (r *PrefixRouter) RegisterVersionedRouter(version string, middlewares ...Handler) Router
  • func (r *PrefixRouter) Static(relativePath string, root string)
  • func (r *PrefixRouter) StaticFile(relativePath string, filepath string)
  • func (r *PrefixRouter) VersionedRouter(version string) Router
• type RootRouter
  • func (r *RootRouter) AddMiddlewares(middlewares ...Handler) Router
  • func (r *RootRouter) AddRoute(method string, relativePath string, middlewares ...Handler) Router
  • func (r *RootRouter) BasePath() string
  • func (r *RootRouter) RegisterVersionedRouter(version string, middlewares ...Handler) Router
  • func (r *RootRouter) ServerHttp(w http.ResponseWriter, req *http.Request)
  • func (r *RootRouter) Static(relativePath string, root string)
  • func (r *RootRouter) StaticFile(relativePath string, filepath string)
  • func (r *RootRouter) VersionedRouter(version string) Router
• type Router
• type TenantInfo
• type UserInfo

Constants

const (
	RouterRoot   = "root"
	RouterPrefix = "prefix"
)

Types

type Api

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

func New

func New(opts ...Option) *Api

func NewWithEngine

func NewWithEngine(server *http.Server, engine *gin.Engine, opts ...Option) *Api

func (*Api) ChooseRouter

func (api *Api) ChooseRouter(routerType string, version string) Router

func (*Api) Finish

func (api *Api) Finish() error

func (*Api) Options

func (api *Api) Options() Options

func (*Api) PrefixRouter

func (api *Api) PrefixRouter() Router

func (*Api) RootRouter

func (api *Api) RootRouter() Router

func (*Api) Start

func (api *Api) Start() error

type Context

type Context struct {
	*gin.Context
}

func (*Context) GetAllPathParams

func (c *Context) GetAllPathParams() map[string]string

func (*Context) GetAllQueryParams

func (c *Context) GetAllQueryParams() map[string]string

func (*Context) GetFileHeaderBytes

func (c *Context) GetFileHeaderBytes(fileHeader *multipart.FileHeader) (string, []byte, error)

GetFileHeaderBytes 获取传递的文件名和文件内容

func (*Context) GetHeaders

func (c *Context) GetHeaders() map[string]string

func (*Context) GetTenantInfo

func (c *Context) GetTenantInfo() TenantInfo

func (*Context) GetUserInfo

func (c *Context) GetUserInfo() UserInfo

func (*Context) ReadBody

func (c *Context) ReadBody() ([]byte, error)

func (*Context) ReadJsonBody

func (c *Context) ReadJsonBody(output any) error

func (*Context) ReplaceBody

func (c *Context) ReplaceBody(body []byte) error

func (*Context) ReplaceJsonBody

func (c *Context) ReplaceJsonBody(body any) error

type Handler

type Handler func(c *Context)

Handler 请求处理函数

type Option

type Option func(options *Options)

func WithPort

func WithPort(port string) Option

func WithUrlPrefix

func WithUrlPrefix(urlPrefix string) Option

type Options

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

func (Options) GetPort

func (options Options) GetPort() string

func (Options) GetUrlPrefix

func (options Options) GetUrlPrefix() string

type PrefixRouter

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

func (*PrefixRouter) AddMiddlewares

func (r *PrefixRouter) AddMiddlewares(middlewares ...Handler) Router

func (*PrefixRouter) AddRoute

func (r *PrefixRouter) AddRoute(method string, relativePath string, middlewares ...Handler) Router

func (*PrefixRouter) BasePath

func (r *PrefixRouter) BasePath() string

func (*PrefixRouter) RegisterVersionedRouter

func (r *PrefixRouter) RegisterVersionedRouter(version string, middlewares ...Handler) Router

func (*PrefixRouter) Static

func (r *PrefixRouter) Static(relativePath string, root string)

func (*PrefixRouter) StaticFile

func (r *PrefixRouter) StaticFile(relativePath string, filepath string)

func (*PrefixRouter) VersionedRouter

func (r *PrefixRouter) VersionedRouter(version string) Router

type RootRouter

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

func (*RootRouter) AddMiddlewares

func (r *RootRouter) AddMiddlewares(middlewares ...Handler) Router

func (*RootRouter) AddRoute

func (r *RootRouter) AddRoute(method string, relativePath string, middlewares ...Handler) Router

func (*RootRouter) BasePath

func (r *RootRouter) BasePath() string

func (*RootRouter) RegisterVersionedRouter

func (r *RootRouter) RegisterVersionedRouter(version string, middlewares ...Handler) Router

func (*RootRouter) ServerHttp

func (r *RootRouter) ServerHttp(w http.ResponseWriter, req *http.Request)

func (*RootRouter) Static

func (r *RootRouter) Static(relativePath string, root string)

func (*RootRouter) StaticFile

func (r *RootRouter) StaticFile(relativePath string, filepath string)

func (*RootRouter) VersionedRouter

func (r *RootRouter) VersionedRouter(version string) Router

type Router

type Router interface {
	AddMiddlewares(middlewares ...Handler) Router
	RegisterVersionedRouter(version string, middlewares ...Handler) Router
	VersionedRouter(version string) Router
	AddRoute(method string, relativePath string, middlewares ...Handler) Router
	Static(relativePath string, root string)
	StaticFile(relativePath string, filepath string)
	BasePath() string
}

type TenantInfo

type TenantInfo interface {
	GetID() string
	GetName() string
}

type UserInfo

type UserInfo interface {
	GetID() string
	GetUserName() string
	GetName() string
}