api

package

v0.0.18 Latest Latest Go to latest Published: Aug 22, 2026 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/VaalaCat/ai-gateway

Links

Open Source Insights

Documentation ¶

Index ¶

func Adapt[Req any, Resp any](adapter *Adapter, mode BindMode, handler HandlerFunc[Req, Resp]) gin.HandlerFunc
func BadRequestError(message string, cause error) error
func ConflictError(message string, cause error) error
func ErrorWithCode(status int, code, message string, details map[string]any) error
func ForbiddenError(message string) error
func InternalError(message string, cause error) error
func MapChannelFileError(err error) error
func NewPostCommitPublishContext(requestCtx context.Context) (context.Context, context.CancelFunc)
func NormalizeAllowedChannelIDs(v any) ([]uint, error)
func NormalizeAllowedGroupIDs(v any) ([]uint, error)
func NormalizePagination(page, pageSize int) (int, int)
func NotFoundError(message string) error
func ParseChannelImportDryRun(raw string) (bool, error)
func ParseTopN(raw int) (int, error)
func ResolveGroupID(q dao.AdminQuery, userID uint) (uint, error)
func SetAttachmentHeaders(c *gin.Context, filename string)
func StatusEqualsEnabled(v any) bool
func UnauthorizedError(message string) error
func ValidateAllowedChannelIDs(ids []uint) error
func ValidateAllowedGroupIDs(ids []uint) error
func ValidateAutoBanValue(v any) error
func ValidateStatusValue(v any) error
func WriteMappedError(adapter *Adapter, c *gin.Context, err error)
type APIError
- func (e *APIError) Error() string
type Accepted
- func (Accepted[T]) HTTPStatus() int
- func (a Accepted[T]) ResponseBody() any
type Adapter
- func NewAdapter(settings *config.MasterRuntimeConfig, logger *zap.Logger, ...) *Adapter
type BindMode
type BodyMapSetter
type BodyProvider
type ContextFactory
type Created
- func (c Created[T]) Body() any
- func (Created[T]) StatusCode() int
type DefaultContextFactory
- func (f DefaultContextFactory) Build(c *gin.Context) *app.Context
type DefaultErrorMapper
- func (DefaultErrorMapper) Map(err error) (int, any)
type DefaultRequestBinder
- func (DefaultRequestBinder) Bind(c *gin.Context, mode BindMode, req any) error
type EmptyRequest
type ErrorMapper
type HTTPResponse
type HandlerFunc
type IDPathRequest
type JSONWriter
- func (JSONWriter) WriteJSON(c *gin.Context, status int, body any)
type PaginatedResponse
type PaginationQuery
type RequestBinder
type ResponseWriter
type StatusCoder
type StatusResponse

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Adapt ¶

func Adapt[Req any, Resp any](adapter *Adapter, mode BindMode, handler HandlerFunc[Req, Resp]) gin.HandlerFunc

func BadRequestError ¶

func BadRequestError(message string, cause error) error

func ConflictError ¶

func ConflictError(message string, cause error) error

func ErrorWithCode ¶

func ErrorWithCode(status int, code, message string, details map[string]any) error

ErrorWithCode 用于需要结构化错误响应的端点（按 code 做前端 i18n）。

func ForbiddenError ¶

func ForbiddenError(message string) error

func InternalError ¶

func InternalError(message string, cause error) error

func MapChannelFileError ¶ added in v0.0.13

func MapChannelFileError(err error) error

func NewPostCommitPublishContext ¶ added in v0.0.16

func NewPostCommitPublishContext(requestCtx context.Context) (context.Context, context.CancelFunc)

NewPostCommitPublishContext keeps request-scoped values while giving authoritative post-commit queries and events their own bounded lifetime.

func NormalizeAllowedChannelIDs ¶

func NormalizeAllowedChannelIDs(v any) ([]uint, error)

NormalizeAllowedChannelIDs converts an arbitrary JSON value (typically from a map[string]any update payload) into []uint, rejecting non-array or non-integer / negative values. A nil input returns nil, nil.

func NormalizeAllowedGroupIDs ¶ added in v0.0.8

func NormalizeAllowedGroupIDs(v any) ([]uint, error)

NormalizeAllowedGroupIDs converts an arbitrary JSON value (typically from a map[string]any update payload) into []uint, rejecting non-array or non-integer / negative values. A nil input returns (nil, nil).

func NormalizePagination ¶

func NormalizePagination(page, pageSize int) (int, int)

func NotFoundError ¶

func NotFoundError(message string) error

func ParseChannelImportDryRun ¶ added in v0.0.13

func ParseChannelImportDryRun(raw string) (bool, error)

func ParseTopN ¶ added in v0.0.14

func ParseTopN(raw int) (int, error)

ParseTopN normalizes the shared page-level chart ranking limit.

func ResolveGroupID ¶ added in v0.0.8

func ResolveGroupID(q dao.AdminQuery, userID uint) (uint, error)

ResolveGroupID 返回 userID 所属用户组 ID。查不到用户时返回 (0, err)。放在 api 包供 token / token_template 等子包共用；只依赖 dao，不依赖 middleware。

func SetAttachmentHeaders ¶ added in v0.0.13

func SetAttachmentHeaders(c *gin.Context, filename string)

func StatusEqualsEnabled ¶ added in v0.0.6

func StatusEqualsEnabled(v any) bool

StatusEqualsEnabled reports whether v decodes to consts.StatusEnabled. Call only after ValidateStatusValue has confirmed v is a legal status.

func UnauthorizedError ¶

func UnauthorizedError(message string) error

func ValidateAllowedChannelIDs ¶

func ValidateAllowedChannelIDs(ids []uint) error

ValidateAllowedChannelIDs validates a slice of channel IDs for token / token_template / user_group. Returns error if length > 100 or any ID is zero.

func ValidateAllowedGroupIDs ¶ added in v0.0.8

func ValidateAllowedGroupIDs(ids []uint) error

ValidateAllowedGroupIDs validates a slice of user-group IDs for token_template. Returns error if length > 100 or any ID is zero.

func ValidateAutoBanValue ¶ added in v0.0.15

func ValidateAutoBanValue(v any) error

ValidateAutoBanValue 保证 auto_ban 与渠道 status 使用相同的严格 0/1 契约。 map JSON 解码后的数字可以是 float64，但仍必须是精确的二态整数。

func ValidateStatusValue ¶

func ValidateStatusValue(v any) error

ValidateStatusValue checks that the provided value is a valid status (consts.StatusEnabled or consts.StatusDisabled). The value may come from a JSON-decoded map[string]any (float64) or from a typed int field.

func WriteMappedError ¶ added in v0.0.13

func WriteMappedError(adapter *Adapter, c *gin.Context, err error)

Types ¶

type APIError ¶

type APIError struct {
	Status  int
	Code    string // 结构化错误 code（前端 i18n 用）
	Message string
	Details map[string]any // 结构化错误细节
	Cause   error
}

func (*APIError) Error ¶

func (e *APIError) Error() string

type Accepted ¶ added in v0.0.13

type Accepted[T any] struct {
	Body T
}

func (Accepted[T]) HTTPStatus ¶ added in v0.0.13

func (Accepted[T]) HTTPStatus() int

func (Accepted[T]) ResponseBody ¶ added in v0.0.13

func (a Accepted[T]) ResponseBody() any

type Adapter ¶

type Adapter struct {
	ContextFactory ContextFactory
	Binder         RequestBinder
	Writer         ResponseWriter
	ErrorMapper    ErrorMapper
}

func NewAdapter ¶

func NewAdapter(settings *config.MasterRuntimeConfig, logger *zap.Logger, application app.Application) *Adapter

type BindMode ¶

type BindMode int

const (
	BindNone BindMode = iota
	BindJSON
	BindOptionalJSON
	BindQuery
	BindURI
	BindURIAndJSON
	BindURIAndOptionalJSON
	BindURIAndQuery
	BindURIAndBodyMap
	BindStrictJSONText
	BindURIAndStrictJSONBodyMap
	BindURIAndStrictJSONText
)

type BodyMapSetter ¶

type BodyMapSetter interface {
	SetBodyMap(map[string]any)
}

type BodyProvider ¶

type BodyProvider interface {
	Body() any
}

type ContextFactory ¶

type ContextFactory interface {
	Build(*gin.Context) *app.Context
}

type Created ¶

type Created[T any] struct {
	Value T
}

func (Created[T]) Body ¶

func (c Created[T]) Body() any

func (Created[T]) StatusCode ¶

func (Created[T]) StatusCode() int

type DefaultContextFactory ¶

type DefaultContextFactory struct {
	Settings *config.MasterRuntimeConfig
	Logger   *zap.Logger
	App      app.Application
}

func (DefaultContextFactory) Build ¶

func (f DefaultContextFactory) Build(c *gin.Context) *app.Context

type DefaultErrorMapper ¶

type DefaultErrorMapper struct{}

func (DefaultErrorMapper) Map ¶

func (DefaultErrorMapper) Map(err error) (int, any)

type DefaultRequestBinder ¶

type DefaultRequestBinder struct{}

func (DefaultRequestBinder) Bind ¶

func (DefaultRequestBinder) Bind(c *gin.Context, mode BindMode, req any) error

type EmptyRequest ¶

type EmptyRequest struct{}

type ErrorMapper ¶

type ErrorMapper interface {
	Map(error) (int, any)
}

type HTTPResponse ¶ added in v0.0.13

type HTTPResponse interface {
	HTTPStatus() int
	ResponseBody() any
}

type HandlerFunc ¶

type HandlerFunc[Req any, Resp any] func(*app.Context, Req) (Resp, error)

type IDPathRequest ¶

type IDPathRequest struct {
	ID string `uri:"id" binding:"required"`
}

type JSONWriter ¶

type JSONWriter struct{}

func (JSONWriter) WriteJSON ¶

func (JSONWriter) WriteJSON(c *gin.Context, status int, body any)

type PaginatedResponse ¶

type PaginatedResponse[T any] struct {
	Data     []T   `json:"data"`
	Total    int64 `json:"total"`
	Page     int   `json:"page"`
	PageSize int   `json:"page_size"`
}

type PaginationQuery ¶

type PaginationQuery struct {
	Page     int `form:"page"`
	PageSize int `form:"page_size"`
}

type RequestBinder ¶

type RequestBinder interface {
	Bind(*gin.Context, BindMode, any) error
}

type ResponseWriter ¶

type ResponseWriter interface {
	WriteJSON(*gin.Context, int, any)
}

type StatusCoder ¶

type StatusCoder interface {
	StatusCode() int
}

type StatusResponse ¶

type StatusResponse struct {
	Status string `json:"status"`
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
agent
agent_route
api_access_grant
api_backend
api_catalog
api_openapi
api_request_log
api_role
api_route
api_service
api_upstream
billing
cache
capability
channel
insights
invite
log
middleware
model
pricing
model_marketplace
model_routing
monitoring
oauth
oauth_provider_admin
observability
private_channel
request_limiter
script
stats
system
token
token_template
user
user_group

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL