BCAI/easyai-ai-gateway
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat(system): 完成客户端自定义与系统设置

Browse Source 
新增管理端客户端自定义标签页、公开与管理端系统设置接口、文件存储设置持久化、数据库迁移、契约类型和 OpenAPI 文档。
This commit is contained in:
chensipeng
2026-06-30 14:53:29 +08:00
parent 229ed6a669
commit 0dc9df759b
12 changed files with 2558 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/api/internal/httpapi/server.go
+3
View File
@@ -52,6 +52,7 @@ func NewServerWithContext(ctx context.Context, cfg config.Config, db *store.Stor
mux.Handle("GET /api/v1/me", server.auth.Require(auth.PermissionBasic, http.HandlerFunc(server.me)))
mux.Handle("GET /api/v1/public/catalog/providers", server.auth.Require(auth.PermissionPublic, http.HandlerFunc(server.listCatalogProviders)))
mux.Handle("GET /api/v1/public/catalog/base-models", server.auth.Require(auth.PermissionPublic, http.HandlerFunc(server.listBaseModels)))
mux.Handle("GET /api/v1/public/client-customization", server.auth.Require(auth.PermissionPublic, http.HandlerFunc(server.getPublicClientCustomizationSettings)))
mux.Handle("GET /api/admin/catalog/providers", server.requireAdmin(auth.PermissionPower, http.HandlerFunc(server.listCatalogProviders)))
mux.Handle("POST /api/admin/catalog/providers", server.requireAdmin(auth.PermissionManager, http.HandlerFunc(server.createCatalogProvider)))
mux.Handle("PATCH /api/admin/catalog/providers/{providerID}", server.requireAdmin(auth.PermissionManager, http.HandlerFunc(server.updateCatalogProvider)))
@@ -115,6 +116,8 @@ func NewServerWithContext(ctx context.Context, cfg config.Config, db *store.Stor
mux.Handle("GET /api/admin/config/network-proxy", server.requireAdmin(auth.PermissionPower, http.HandlerFunc(server.getNetworkProxyConfig)))
mux.Handle("GET /api/admin/system/file-storage/settings", server.requireAdmin(auth.PermissionPower, http.HandlerFunc(server.getFileStorageSettings)))
mux.Handle("PATCH /api/admin/system/file-storage/settings", server.requireAdmin(auth.PermissionManager, http.HandlerFunc(server.updateFileStorageSettings)))
mux.Handle("GET /api/admin/system/client-customization/settings", server.requireAdmin(auth.PermissionPower, http.HandlerFunc(server.getClientCustomizationSettings)))
mux.Handle("PATCH /api/admin/system/client-customization/settings", server.requireAdmin(auth.PermissionManager, http.HandlerFunc(server.updateClientCustomizationSettings)))
mux.Handle("GET /api/admin/system/file-storage/channels", server.requireAdmin(auth.PermissionPower, http.HandlerFunc(server.listFileStorageChannels)))
mux.Handle("POST /api/admin/system/file-storage/channels", server.requireAdmin(auth.PermissionManager, http.HandlerFunc(server.createFileStorageChannel)))
mux.Handle("PATCH /api/admin/system/file-storage/channels/{channelID}", server.requireAdmin(auth.PermissionManager, http.HandlerFunc(server.updateFileStorageChannel)))
apps/api/internal/httpapi/system_settings_handlers.go
+70
View File
@@ -83,6 +83,76 @@ func (s *Server) updateFileStorageSettings(w http.ResponseWriter, r *http.Reques
writeJSON(w, http.StatusOK, settings)
}
// getClientCustomizationSettings godoc
// @Summary 获取客户端自定义设置
// @Description 返回客户端名称、英文名称、平台名和图标路径；数据库对象尚未创建时返回默认设置。
// @Tags system
// @Produce json
// @Security BearerAuth
// @Success 200 {object} store.ClientCustomizationSettings
// @Failure 401 {object} ErrorEnvelope
// @Failure 403 {object} ErrorEnvelope
// @Failure 500 {object} ErrorEnvelope
// @Router /api/admin/system/client-customization/settings [get]
func (s *Server) getClientCustomizationSettings(w http.ResponseWriter, r *http.Request) {
s.writeClientCustomizationSettings(w, r)
}
// getPublicClientCustomizationSettings godoc
// @Summary 获取公开客户端自定义设置
// @Description 无需鉴权返回客户端名称、英文名称、平台名和图标路径；数据库对象尚未创建时返回默认设置。
// @Tags system
// @Produce json
// @Success 200 {object} store.ClientCustomizationSettings
// @Failure 500 {object} ErrorEnvelope
// @Router /api/v1/public/client-customization [get]
func (s *Server) getPublicClientCustomizationSettings(w http.ResponseWriter, r *http.Request) {
s.writeClientCustomizationSettings(w, r)
}
func (s *Server) writeClientCustomizationSettings(w http.ResponseWriter, r *http.Request) {
settings, err := s.store.GetClientCustomizationSettings(r.Context())
if err != nil {
if store.IsUndefinedDatabaseObject(err) {
writeJSON(w, http.StatusOK, store.DefaultClientCustomizationSettings())
return
}
s.logger.Error("get client customization settings failed", "error", err)
writeError(w, http.StatusInternalServerError, "get client customization settings failed")
return
}
writeJSON(w, http.StatusOK, settings)
}
// updateClientCustomizationSettings godoc
// @Summary 更新客户端自定义设置
// @Description 更新客户端名称、英文名称、平台名和图标路径。
// @Tags system
// @Accept json
// @Produce json
// @Security BearerAuth
// @Param body body store.ClientCustomizationSettingsInput true "客户端自定义设置"
// @Success 200 {object} store.ClientCustomizationSettings
// @Failure 400 {object} ErrorEnvelope
// @Failure 401 {object} ErrorEnvelope
// @Failure 403 {object} ErrorEnvelope
// @Failure 500 {object} ErrorEnvelope
// @Router /api/admin/system/client-customization/settings [patch]
func (s *Server) updateClientCustomizationSettings(w http.ResponseWriter, r *http.Request) {
var input store.ClientCustomizationSettingsInput
if err := json.NewDecoder(r.Body).Decode(&input); err != nil {
writeError(w, http.StatusBadRequest, "invalid json body")
return
}
settings, err := s.store.UpdateClientCustomizationSettings(r.Context(), input)
if err != nil {
s.logger.Error("update client customization settings failed", "error", err)
writeError(w, http.StatusInternalServerError, "update client customization settings failed")
return
}
writeJSON(w, http.StatusOK, settings)
}
// createFileStorageChannel godoc
// @Summary 创建文件存储通道
// @Description 创建文件存储通道，当前主要用于配置 server-main OpenAPI 上传通道。
apps/api/internal/store/file_storage_channels.go
+112 -1
View File
@@ -24,6 +24,7 @@ const (
)
const SystemSettingFileStorage = "file_storage"
const SystemSettingClientCustomization = "client_customization"
const fileStorageChannelColumns = `
id::text, channel_key, name, provider, COALESCE(upload_url, ''), credentials,
@@ -72,6 +73,20 @@ type FileStorageSettingsInput struct {
ResultUploadPolicy string `json:"resultUploadPolicy"`
}
type ClientCustomizationSettings struct {
ClientName string `json:"clientName"`
ClientEnglishName string `json:"clientEnglishName"`
PlatformName string `json:"platformName"`
IconPath string `json:"iconPath"`
}
type ClientCustomizationSettingsInput struct {
ClientName *string `json:"clientName"`
ClientEnglishName *string `json:"clientEnglishName"`
PlatformName *string `json:"platformName"`
IconPath *string `json:"iconPath"`
}
type fileStorageChannelScanner interface {
Scan(dest ...any) error
}
@@ -348,6 +363,15 @@ func DefaultFileStorageSettings() FileStorageSettings {
return FileStorageSettings{ResultUploadPolicy: FileStorageResultUploadPolicyDefault}
}
func DefaultClientCustomizationSettings() ClientCustomizationSettings {
return ClientCustomizationSettings{
ClientName: "EasyAI AI Gateway",
ClientEnglishName: "EasyAI AI Gateway",
PlatformName: "EasyAI",
IconPath: "",
}
}
func (s *Store) GetFileStorageSettings(ctx context.Context) (FileStorageSettings, error) {
var value []byte
err := s.pool.QueryRow(ctx, `
@@ -380,13 +404,53 @@ func (s *Store) UpdateFileStorageSettings(ctx context.Context, input FileStorage
return fileStorageSettingsFromValue(decodeObject(saved)), nil
}
func (s *Store) GetClientCustomizationSettings(ctx context.Context) (ClientCustomizationSettings, error) {
var value []byte
err := s.pool.QueryRow(ctx, `
SELECT value
FROM system_settings
WHERE setting_key = $1`, SystemSettingClientCustomization).Scan(&value)
if err != nil {
if IsNotFound(err) {
return DefaultClientCustomizationSettings(), nil
}
return ClientCustomizationSettings{}, err
}
return clientCustomizationSettingsFromValue(decodeObject(value)), nil
}
func (s *Store) UpdateClientCustomizationSettings(ctx context.Context, input ClientCustomizationSettingsInput) (ClientCustomizationSettings, error) {
current, err := s.GetClientCustomizationSettings(ctx)
if err != nil && !IsUndefinedDatabaseObject(err) {
return ClientCustomizationSettings{}, err
}
settings := normalizeClientCustomizationSettings(input, current)
value, _ := json.Marshal(settings)
var saved []byte
err = s.upsertSystemSetting(ctx, SystemSettingClientCustomization, value, &saved)
if err != nil && IsUndefinedDatabaseObject(err) {
if ensureErr := s.ensureSystemSettingsTable(ctx); ensureErr != nil {
return ClientCustomizationSettings{}, ensureErr
}
err = s.upsertSystemSetting(ctx, SystemSettingClientCustomization, value, &saved)
}
if err != nil {
return ClientCustomizationSettings{}, err
}
return clientCustomizationSettingsFromValue(decodeObject(saved)), nil
}
func (s *Store) upsertFileStorageSettings(ctx context.Context, value []byte, saved *[]byte) error {
return s.upsertSystemSetting(ctx, SystemSettingFileStorage, value, saved)
}
func (s *Store) upsertSystemSetting(ctx context.Context, settingKey string, value []byte, saved *[]byte) error {
return s.pool.QueryRow(ctx, `
INSERT INTO system_settings (setting_key, value)
VALUES ($1, $2)
ON CONFLICT (setting_key)
DO UPDATE SET value = EXCLUDED.value, updated_at = now()
RETURNING value`, SystemSettingFileStorage, value).Scan(saved)
RETURNING value`, settingKey, value).Scan(saved)
}
func (s *Store) ensureSystemSettingsTable(ctx context.Context) error {
@@ -409,6 +473,53 @@ func fileStorageSettingsFromValue(value map[string]any) FileStorageSettings {
return settings
}
func clientCustomizationSettingsFromValue(value map[string]any) ClientCustomizationSettings {
settings := DefaultClientCustomizationSettings()
if value == nil {
return settings
}
if clientName := stringFromAny(value["clientName"]); clientName != "" {
settings.ClientName = clientName
}
if clientEnglishName := stringFromAny(value["clientEnglishName"]); clientEnglishName != "" {
settings.ClientEnglishName = clientEnglishName
}
if platformName := stringFromAny(value["platformName"]); platformName != "" {
settings.PlatformName = platformName
}
settings.IconPath = stringFromAny(value["iconPath"])
return settings
}
func normalizeClientCustomizationSettings(input ClientCustomizationSettingsInput, current ClientCustomizationSettings) ClientCustomizationSettings {
settings := current
if settings.ClientName == "" && settings.ClientEnglishName == "" && settings.PlatformName == "" {
settings = DefaultClientCustomizationSettings()
}
if input.ClientName != nil {
settings.ClientName = strings.TrimSpace(*input.ClientName)
}
if input.ClientEnglishName != nil {
settings.ClientEnglishName = strings.TrimSpace(*input.ClientEnglishName)
}
if input.PlatformName != nil {
settings.PlatformName = strings.TrimSpace(*input.PlatformName)
}
if input.IconPath != nil {
settings.IconPath = strings.TrimSpace(*input.IconPath)
}
if settings.ClientName == "" {
settings.ClientName = DefaultClientCustomizationSettings().ClientName
}
if settings.ClientEnglishName == "" {
settings.ClientEnglishName = DefaultClientCustomizationSettings().ClientEnglishName
}
if settings.PlatformName == "" {
settings.PlatformName = DefaultClientCustomizationSettings().PlatformName
}
return settings
}
func NormalizeFileStorageResultUploadPolicy(policy string) string {
normalized := strings.ToLower(strings.TrimSpace(policy))
normalized = strings.ReplaceAll(normalized, "-", "_")