api

Feb 10, 2026

Changes in this version

type PermUrlInstruction

+ Privilege bool

type PermissionItem

+ Privilege bool

Jan 30, 2026

Changes in this version

+ type PathParams struct

+ func (pathParams *PathParams) Delete(key string)

+ func (pathParams *PathParams) Get(key string) string

+ func (pathParams *PathParams) Map() map[string]string

+ func (pathParams *PathParams) Reload()

+ func (pathParams *PathParams) Set(key string, value string)

+ func (pathParams *PathParams) SetMap(mapPathParams map[string]string)

+ type QueryParams struct

+ func (queryParams *QueryParams) Delete(key string)

+ func (queryParams *QueryParams) Get(key string) string

+ func (queryParams *QueryParams) Map() map[string]string

+ func (queryParams *QueryParams) Reload()

+ func (queryParams *QueryParams) Set(key string, value string)

+ func (queryParams *QueryParams) SetMap(mapQueryParams map[string]string)

Jan 30, 2026

Changes in this version

+ func FormUrlInstruction(instructions ...UrlInstruction) string

+ type PermUrlInstruction struct

+ Description string

+ Group string

+ Name string

+ NeedCheckExpire bool

+ SensitiveWordScene int

+ func (cmd *PermUrlInstruction) FormUrlInstruction() (string, error)

+ type UrlInstruction interface

+ FormUrlInstruction func() (string, error)

Dec 26, 2025

Changes in this version

type Api

+ func (api *Api) DumpRouterPermissionItems() (*DumpedPermissionItems, error)

+ type DumpPermissionItemsOption struct

+ Gateway string

+ Namespace string

+ SaveDir string

+ type DumpedPermissionItems struct

+ Delete []PermissionItem

+ Gateway string

+ Namespace string

+ New []PermissionItem

+ Update []PermissionItem

type Option

+ func WithDumpPermissionItemsOption(option *DumpPermissionItemsOption) Option

+ type PermissionItem struct

+ Action string

+ Description string

+ Group string

+ Name string

+ NeedCheckExpire bool

+ Resource string

+ SensitiveWordScene int

type PrefixRouter

+ func (r *PrefixRouter) DumpPermissionItems() []PermissionItem

type RootRouter

+ func (r *RootRouter) DumpPermissionItems() []PermissionItem

type Router

+ DumpPermissionItems func() []PermissionItem

Jun 24, 2024

Changes in this version

type JsonBody

+ func (jsonBody *JsonBody) SetMap(mapBody map[string]any)

type PathPrams

+ func (pathParams *PathPrams) SetMap(mapPathParams map[string]string)

type QueryPrams

+ func (queryParams *QueryPrams) SetMap(mapQueryParams map[string]string)

Jun 24, 2024

Changes in this version

type JsonBody

+ func (jsonBody *JsonBody) SetMapBody(mapBody map[string]any)

Jun 21, 2024

Changes in this version

type BytesBody

+ func (bytesBody *BytesBody) Reload() error

type Context

+ func (c *Context) ReadOriginHeader() map[string]string

type Header

+ func (header *Header) Reload()

type JsonBody

+ func (jsonBody *JsonBody) Reload() error

type PathPrams

+ func (pathParams *PathPrams) Reload()

type QueryPrams

+ func (queryParams *QueryPrams) Reload()

Jun 20, 2024

Changes in this version

type Context

+ func (c *Context) GetOriginPathParams() map[string]string

+ func (c *Context) GetOriginQueryParams() map[string]string

+ func (c *Context) ReadOriginBody() ([]byte, error)

Jun 18, 2024

Changes in this version

+ type BytesBody struct

+ func (bytesBody *BytesBody) Bytes() []byte

+ func (bytesBody *BytesBody) Marshal(input any) error

+ func (bytesBody *BytesBody) Set(body []byte)

+ func (bytesBody *BytesBody) Unmarshal(output any) error

type Option

+ func WithLogSkipPaths(logSkipPaths ...string) Option

Jun 15, 2024

Changes in this version

type Option

+ func WithSkipPaths(skipPaths ...string) Option

Jun 15, 2024

Changes in this version

type Context

+ func (c *Context) GetHeader() *Header

+ type Header struct

+ func (header *Header) Get(key string) string

+ func (header *Header) Map() map[string]string

+ func (header *Header) Set(key string, value string)

Jun 14, 2024

Changes in this version

type CacheBody

+ func (cacheBody *CacheBody) Marshal(output any) error

+ func (cacheBody *CacheBody) Unmarshal(output any) error

Jun 12, 2024

Changes in this version

type Context

+ func (c *Context) SetTenantInfo(tenantInfo TenantInfo)

+ func (c *Context) SetUserInfo(userInfo UserInfo)

Jun 4, 2024

Changes in this version

+ type CacheBody struct

+ func (cacheBody *CacheBody) Bytes() []byte

+ func (cacheBody *CacheBody) Set(bytesBody []byte)

type Context

+ func (c *Context) GetBytesBody() (*CacheBody, error)

+ func (c *Context) GetJsonBody() (*JsonBody, error)

+ func (c *Context) GetPathParams() *PathPrams

+ func (c *Context) GetQueryParams() *QueryPrams

+ type JsonBody struct

+ func (jsonBody *JsonBody) Bytes() ([]byte, error)

+ func (jsonBody *JsonBody) Delete(key string)

+ func (jsonBody *JsonBody) Get(key string) any

+ func (jsonBody *JsonBody) Map() map[string]any

+ func (jsonBody *JsonBody) Set(key string, value any)

+ func (jsonBody *JsonBody) Unmarshal(output any) error

+ type PathPrams struct

+ func (pathParams *PathPrams) Delete(key string)

+ func (pathParams *PathPrams) Get(key string) string

+ func (pathParams *PathPrams) Map() map[string]string

+ func (pathParams *PathPrams) Set(key string, value string)

+ type QueryPrams struct

+ func (queryParams *QueryPrams) Delete(key string)

+ func (queryParams *QueryPrams) Get(key string) string

+ func (queryParams *QueryPrams) Map() map[string]string

+ func (queryParams *QueryPrams) Set(key string, value string)

May 30, 2024

Changes in this version

type Context

+ func (c *Context) GetTenantInfo() TenantInfo

+ func (c *Context) GetUserInfo() UserInfo

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

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

+ type TenantInfo interface

+ GetID func() string

+ GetName func() string

+ type UserInfo interface

+ GetID func() string

+ GetName func() string

+ GetUserName func() string

May 30, 2024

Changes in this version

type Api

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

type Context

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

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

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

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

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

May 27, 2024

Changes in this version

+ const RouterPrefix

+ const RouterRoot

type Api

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

May 25, 2024

Changes in this version

+ type Api struct

+ func New(opts ...Option) *Api

+ 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 struct

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

+ type Handler func(c *Context)

+ type Option func(options *Options)

+ func WithPort(port string) Option

+ func WithUrlPrefix(urlPrefix string) Option

+ type Options struct

+ func (options Options) GetPort() string

+ func (options Options) GetUrlPrefix() string

+ type PrefixRouter struct

+ 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 struct

+ 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 interface

+ AddMiddlewares func(middlewares ...Handler) Router

+ AddRoute func(method string, relativePath string, middlewares ...Handler) Router

+ BasePath func() string

+ RegisterVersionedRouter func(version string, middlewares ...Handler) Router

+ Static func(relativePath string, root string)

+ StaticFile func(relativePath string, filepath string)

+ VersionedRouter func(version string) Router