phalapi PhalApi开源接口框架 首页 接口文档 开发文档
语言
简体中文 English
# 请求方式 接口服务 接口名称 接口描述
1GET/POSTApp.Hello.World示例接口//请使用@desc 注释
2GET/POSTApp.AdminApi.ApiStatsAPI调用统计//请使用@desc 注释
3GET/POSTApp.AdminApi.SaveConfig保存API配置//请使用@desc 注释
4GET/POSTApp.AdminApi.ProviderSave保存服务商//请使用@desc 注释
5GET/POSTApp.AdminApi.ModelSave保存模型//请使用@desc 注释
6GET/POSTApp.AdminApi.ProviderDelete删除服务商//请使用@desc 注释
7GET/POSTApp.AdminApi.ModelDelete删除模型//请使用@desc 注释
8GET/POSTApp.AdminApi.TenantPointsList租户点数列表//请使用@desc 注释
9GET/POSTApp.AdminApi.GetConfig获取API配置//请使用@desc 注释
10GET/POSTApp.AdminApi.ProviderList获取服务商列表//请使用@desc 注释
11GET/POSTApp.AdminApi.ModelList获取模型列表//请使用@desc 注释
12GET/POSTApp.AdminApi.TenantPointsAdjust调整租户点数//请使用@desc 注释
13GET/POSTApp.AdminPointsConfig.Save保存扣点配置//请使用@desc 注释
14GET/POSTApp.AdminPointsConfig.Delete删除扣点配置//请使用@desc 注释
15GET/POSTApp.AdminPointsConfig.UpdateStatus更新状态//请使用@desc 注释
16GET/POSTApp.AdminPointsConfig.GetList获取扣点配置列表//请使用@desc 注释
17GET/POSTApp.AdminPromptTemplate.Create创建模板//请使用@desc 注释
18GET/POSTApp.AdminPromptTemplate.Delete删除模板//请使用@desc 注释
19GET/POSTApp.AdminPromptTemplate.Update更新模板//请使用@desc 注释
20GET/POSTApp.AdminPromptTemplate.GetPublicList获取公开模板列表(供租户同步用)//请使用@desc 注释
21GET/POSTApp.AdminPromptTemplate.GetList获取模板列表//请使用@desc 注释
22GET/POSTApp.Admin.Upload上传文件(总控后台用) 上传图片等文件到服务器
23GET/POSTApp.Admin.ChangePassword修改密码 需要登录
24GET/POSTApp.Admin.TenantCreate创建租户 创建新租户并初始化管理员账号,租户编码自动生成
25GET/POSTApp.Admin.TenantDelete删除租户 删除租户及其所有数据
26GET/POSTApp.Admin.TenantUpdate更新租户 更新租户信息
27GET/POSTApp.Admin.TenantList租户列表 获取所有租户列表
28GET/POSTApp.Admin.TenantStats租户统计 获取租户统计数据
29GET/POSTApp.Admin.TenantDetail租户详情 获取单个租户详细信息
30GET/POSTApp.Admin.Login管理员登录 总控后台登录接口
31GET/POSTApp.Admin.Info获取当前管理员信息 需要登录
32GET/POSTApp.Examples_QrCode.Png二维码 - 根据文本内容,生成二维码 可根据传入的文本内容,生成对应的二维码,还可以调整尺寸大小。可以直接输出png图片,也可以返回base64后的图片数据。
33GET/POSTApp.Examples_DataApi.CreateData创建新数据 通用数据接口,创建一条新数据
34GET/POSTApp.Examples_Rule.JsonArray参数示例 - JSON数组参数 演示如何配置JSON格式的数组参数,并原路返回。
35GET/POSTApp.Examples_Rule.ExplodeArray参数示例 - 分割的数组参数 以英文逗号分割的数组,并且可以设置数组个数。
36GET/POSTApp.Examples_Rule.Str参数示例 - 字符串参数 简单的字符串参数
37GET/POSTApp.Examples_Rule.TrueOrFalse参数示例 - 开关参数 true或false的开关参数。
38GET/POSTApp.Examples_Rule.RangeNumber参数示例 - 指定范围的整数参数 指定范围的整数参数,可以设置最小值、最大值,当设定默认值时,对客户端则不是必传参数。
39GET/POSTApp.Examples_Rule.Number参数示例 - 整数参数 必须的整数参数
40GET/POSTApp.Examples_Rule.DateStr参数示例 - 日期参数 字符串的日期参数,例如格式:Y-m-d H:i:s
41GET/POSTApp.Examples_Rule.DateTimestamp参数示例 - 时间戳日期参数 时间戳日期参数,输入日期字符串参数,如传:2019-03-01 00:00:00,接口接收后会转成:1551369600。
42GET/POSTApp.Examples_Rule.SexEnum参数示例 - 枚举参数 例如,男或女的性别参数。
43GET/POSTApp.Examples_Rule.RegexStr参数示例 - 正则字符串参数 指定正则的字符串参数
44GET/POSTApp.Examples_Rule.VersionCallback参数示例 - 版本回调参数 回调类型的参数,可以自定义参数的检测、转换和校验逻辑。例如版本号。
45GET/POSTApp.Examples_Rule.StatusEnum参数示例 - 状态枚举参数 对于是数值的枚举范围,注意配置时请用字符串类型。
46GET/POSTApp.Examples_Rule.DefaultStr参数示例 - 默认且必须的字符串参数 带默认值,并且为必须的字符串参数。默认是string类型,所以一般不用配置type为string。
47GET/POSTApp.Examples_Response.Debug展示调试相关能力 使用前请开启调试模式,效果更佳
48GET/POSTApp.Examples_DataApi.DeleteDataIDs批量删除 通用数据接口,根据ID批量删除数据
49GET/POSTApp.Examples_CURD.Delete数据库示例 - 删除数据 根据ID删除数据库中的一条纪录数据
50GET/POSTApp.Examples_CURD.Insert数据库示例 - 插入数据 向数据库插入一条纪录数据
51POSTApp.Examples_CURD.Update数据库示例 - 更新数据 根据ID更新数据库中的一条纪录数据
52GET/POSTApp.Examples_CURD.SqlDebug数据库示例 - 演示如何进行SQL调试和相关的使用 除此接口外,其他示例也可进行在线调试。本示例将便详细说明如何调试。
53GET/POSTApp.Examples_CURD.GetList数据库示例 - 获取分页列表数据 根据状态筛选列表数据,支持分页
54GETApp.Examples_CURD.Get数据库示例 - 获取数据 根据ID获取数据库中的一条纪录数据
55POSTApp.Examples_Upload.Go文件上传 - 图片文件上传 只能上传单个图片文件
56GETApp.Examples_Docs.Usage文档示例 - 接口文档使用示例 接口说明,更多使用请参考官方文档http://docs.phalapi.net/#/v2.0/api-docs
57GET/POSTApp.Examples_Log.Run日记 - 写入日志 演示日志操作,包括写系统异常类日志、业务纪录类日志、开发调试类日志
58GET/POSTApp.Examples_DataApi.UpdateData更新数据 通用数据接口,根据ID更新单条数据
59GET/POSTApp.Examples_DataApi.DeleteData根据ID删除数据 根据单个ID删除数据,也可以调整成根据自定义的条件删除数据
60GET/POSTApp.Examples_Response.TopResult演示在返回结果根节点添加额外的字段返回 自定义动态返回JSON根节点,增加最外层返回消息,例如最外层的【status 状态码】和【time 当前系统时间】
61GET/POSTApp.Examples_DataApi.GetData获取一条数据 通用数据接口,根据ID获取一条数据
62GET/POSTApp.Examples_DataApi.TableList获取表格列表数据 通用数据接口,获取表格列表数据,默认按ID降序返回,支持分页和搜索
63GET/POSTApp.PromptTemplate.SyncFromSystem从系统模板同步 将总控后台的模板同步到当前租户
64GET/POSTApp.PromptTemplate.Create创建模板//请使用@desc 注释
65GET/POSTApp.PromptTemplate.Delete删除模板//请使用@desc 注释
66GET/POSTApp.PromptTemplate.IncrementUse增加使用次数//请使用@desc 注释
67GET/POSTApp.PromptTemplate.Update更新模板//请使用@desc 注释
68GET/POSTApp.PromptTemplate.GetPublicList获取公开模板列表(前台展示)//请使用@desc 注释
69GET/POSTApp.PromptTemplate.GetList获取模板列表(管理端)//请使用@desc 注释
70GET/POSTApp.PromptTemplate.GetDetail获取模板详情//请使用@desc 注释
71GET/POSTApp.Video.Create创建视频生成任务//请使用@desc 注释
72GET/POSTApp.Video.RefreshPending刷新所有pending状态的任务 批量查询并更新所有pending状态的任务
73GET/POSTApp.Video.Query查询任务状态//请使用@desc 注释
74GET/POSTApp.Video.AdminFixTask管理员修复:强制更新任务状态(不受 tenant_id 限制) 用于修复 tenant_id 不匹配的任务
75GET/POSTApp.Video.History获取历史记录//请使用@desc 注释
76GET/POSTApp.Video.GetModels获取可用模型列表//请使用@desc 注释
77GET/POSTApp.Video.GetBalance获取点数余额 获取当前用户的点数余额
78GET/POSTApp.Video.DebugQueryInternal调试:内部查询处理结果//请使用@desc 注释
79GET/POSTApp.Video.DebugQuery调试:查询任务状态(返回原始API响应) 调试用,查看外部API返回的原始数据
80GET/POSTApp.Video.TestApi调试:测试API连接 测试外部API是否可连接
81GET/POSTApp.Video.DebugUser调试:获取用户信息 调试用,查看当前用户信息
82GET/POSTApp.Tenant.DeepseekChatDeepSeek聊天 调用DeepSeek API生成视频提示词
83GET/POSTApp.Tenant.SaveDeepseekConfig保存DeepSeek配置 保存或更新DeepSeek API配置
84GET/POSTApp.Tenant.SaveDomainConfig保存域名配置 保存租户的自定义域名
85GET/POSTApp.Tenant.SaveMiniappConfig保存小程序配置//请使用@desc 注释
86GET/POSTApp.Tenant.SavePointsConfig保存扣点配置 保存单个选项的扣点配置
87GET/POSTApp.Tenant.SavePaymentConfig保存支付配置//请使用@desc 注释
88GET/POSTApp.Tenant.SaveSettings保存租户基础设置 保存Logo、客服信息等设置
89GET/POSTApp.Tenant.SaveBanner保存轮播图 新增或更新轮播图
90GET/POSTApp.Tenant.ChangePassword修改密码 修改当前登录用户的密码
91GET/POSTApp.Tenant.RedeemCode兑换码兑换 使用兑换码获取积分
92GET/POSTApp.Tenant.CreateRedeemCode创建兑换码 租户管理员批量生成兑换码
93GET/POSTApp.Tenant.UserCreate创建用户//请使用@desc 注释
94GET/POSTApp.Tenant.DeleteRedeemCode删除兑换码//请使用@desc 注释
95GET/POSTApp.Tenant.UserDelete删除用户//请使用@desc 注释
96GET/POSTApp.Tenant.DeleteBanner删除轮播图//请使用@desc 注释
97GET/POSTApp.Tenant.SendCode发送验证码 发送手机验证码用于注册
98GET/POSTApp.Tenant.WxLogin微信小程序登录 使用微信code自动登录,如果用户不存在则自动注册
99GET/POSTApp.Tenant.BatchSavePointsConfig批量保存扣点配置 批量保存多个选项的扣点配置
100GET/POSTApp.Tenant.UpdateStorageConfig更新存储配置 更新OSS配置(仅OSS模式可用)
101GET/POSTApp.Tenant.UserUpdate更新用户//请使用@desc 注释
102GET/POSTApp.Tenant.CheckDomain检测域名解析状态 检测自定义域名是否正确解析
103GET/POSTApp.Tenant.AddUser添加用户(简化版) 快速添加用户,仅需用户名和密码
104GET/POSTApp.Tenant.RegisterByUsername用户名注册 使用用户名和密码注册新用户(无需验证码)
105GET/POSTApp.Tenant.Register用户注册 手机号注册新用户
106GET/POSTApp.Tenant.DisableRedeemCode禁用兑换码//请使用@desc 注释
107GET/POSTApp.Tenant.Login租户用户登录 登录后返回 token,后续请求需在 Header 中携带 Authorization: Bearer {token}
108GET/POSTApp.Tenant.GetDeepseekConfig获取DeepSeek配置 获取当前租户的DeepSeek API配置
109GET/POSTApp.Tenant.GetRedeemCodeList获取兑换码列表 租户管理员获取兑换码列表
110GET/POSTApp.Tenant.GetPublicBanners获取公开轮播图 前台获取启用的轮播图列表(无需登录)
111GET/POSTApp.Tenant.GetDomainConfig获取域名配置 获取租户的自定义域名配置
112GET/POSTApp.Tenant.GetStorageConfig获取存储配置 获取当前租户的OSS配置(仅OSS模式可用)
113GET/POSTApp.Tenant.GetMiniappConfig获取小程序配置//请使用@desc 注释
114GET/POSTApp.Tenant.Info获取当前租户和用户信息 需要登录后调用
115GET/POSTApp.Tenant.GetPointsConfig获取扣点配置 获取租户的各项目扣点配置(细粒度)
116GET/POSTApp.Tenant.GetPaymentList获取支付配置列表//请使用@desc 注释
117GET/POSTApp.Tenant.GetPaymentConfig获取支付配置详情//请使用@desc 注释
118GET/POSTApp.Tenant.PointsLog获取点数变动记录 获取当前用户的点数变动历史
119GET/POSTApp.Tenant.GenerateLog获取生成记录 按类型获取视频/图片生成记录
120GET/POSTApp.Tenant.UserList获取用户列表//请使用@desc 注释
121GET/POSTApp.Tenant.GetPublicInfo获取租户公开信息 无需登录,用于前台页面初始化时获取租户信息
122GET/POSTApp.Tenant.GetSettings获取租户基础设置 获取Logo、客服信息等设置
123GET/POSTApp.Tenant.GetPublicPointsConfig获取租户扣点配置(公开接口) 无需登录,前端页面获取扣点价格配置
124GET/POSTApp.Tenant.GetStats获取租户统计数据 获取用户数、点数、视频数、图片数等统计
125GET/POSTApp.Tenant.GetBannerList获取轮播图列表 获取当前租户的轮播图列表(后台管理用)
126GET/POSTApp.Tenant.UserAdjustPoints调整用户点数 增加或减少用户点数
127GET/POSTApp.Asset.Upload上传文件 上传图片、视频等文件
128GET/POSTApp.Asset.CreateFolder创建分组 创建新的资产分组
129GET/POSTApp.Asset.DeleteFolder删除分组 删除资产分组(分组内资产移到默认)
130GET/POSTApp.Asset.Delete删除资产 删除单个资产
131GET/POSTApp.Asset.BatchDelete批量删除资产 批量删除多个资产
132GET/POSTApp.Asset.Update更新资产信息 更新资产的分组、标签等信息
133GET/POSTApp.Asset.MoveToFolder移动到分组 批量移动资产到指定分组
134GET/POSTApp.Asset.Folders获取分组列表 获取当前用户的所有分组
135GET/POSTApp.Asset.GetStorageInfo获取存储信息 获取当前租户的存储使用情况
136GET/POSTApp.Asset.List获取资产列表 获取当前用户的资产列表,支持按类型、分组筛选
137GET/POSTApp.Asset.Detail获取资产详情 获取单个资产的详细信息
切换到折叠版
温馨提示: 此接口文档根据接口代码和注释实时自动生成,可在接口类的文件注释的第一行修改左侧菜单标题。
PhalApi

接口,从简单开始!
© 2015-2026 Powered By PhalApi开源接口框架 2.23.0    专业版