| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.Hello.World | 示例接口 | //请使用@desc 注释 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.Employee.AssignRoles | 分配角色 | 为员工分配角色 |
| 2 | GET/POST | App.Employee.AssignStores | 分配门店权限 | 为员工分配门店数据权限 |
| 3 | GET/POST | App.Employee.Create | 创建员工 | 创建新员工账号 |
| 4 | GET/POST | App.Employee.Enable | 启用员工 | 启用员工账号 |
| 5 | GET/POST | App.Employee.BatchCreate | 批量创建员工 | 批量创建员工账号 |
| 6 | GET/POST | App.Employee.Update | 更新员工 | 更新员工信息 |
| 7 | GET/POST | App.Employee.Disable | 禁用员工 | 禁用员工账号 |
| 8 | GET/POST | App.Employee.GetList | 获取员工列表 | 获取员工列表 |
| 9 | GET/POST | App.Employee.GetInfo | 获取员工详情 | 获取员工详细信息 |
| 10 | GET/POST | App.Employee.ResetPassword | 重置密码 | 重置员工密码 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.Platform_Tenant.Audit | 审核租户申请 | 审核通过或驳回租户注册申请 |
| 2 | GET/POST | App.Platform_Tenant.GetAuditList | 获取待审核列表 | 获取租户注册申请列表 |
| 3 | GET/POST | App.Platform_Tenant.GetList | 获取租户列表 | 获取所有租户列表，支持筛选和搜索 |
| 4 | GET/POST | App.Platform_Tenant.SetVersion | 设置租户版本 | 为租户设置版本和到期日期 |
| 5 | GET/POST | App.Platform_Tenant.SetStatus | 设置租户状态 | 变更租户状态（启用/暂停/冻结/注销） |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.Examples_QrCode.Png | 二维码 - 根据文本内容，生成二维码 | 可根据传入的文本内容，生成对应的二维码，还可以调整尺寸大小。可以直接输出png图片，也可以返回base64后的图片数据。 |
| 2 | GET/POST | App.Examples_DataApi.CreateData | 创建新数据 | 通用数据接口，创建一条新数据 |
| 3 | GET/POST | App.Examples_Rule.JsonArray | 参数示例 - JSON数组参数 | 演示如何配置JSON格式的数组参数，并原路返回。 |
| 4 | GET/POST | App.Examples_Rule.ExplodeArray | 参数示例 - 分割的数组参数 | 以英文逗号分割的数组，并且可以设置数组个数。 |
| 5 | GET/POST | App.Examples_Rule.Str | 参数示例 - 字符串参数 | 简单的字符串参数 |
| 6 | GET/POST | App.Examples_Rule.TrueOrFalse | 参数示例 - 开关参数 | true或false的开关参数。 |
| 7 | GET/POST | App.Examples_Rule.RangeNumber | 参数示例 - 指定范围的整数参数 | 指定范围的整数参数，可以设置最小值、最大值，当设定默认值时，对客户端则不是必传参数。 |
| 8 | GET/POST | App.Examples_Rule.Number | 参数示例 - 整数参数 | 必须的整数参数 |
| 9 | GET/POST | App.Examples_Rule.DateStr | 参数示例 - 日期参数 | 字符串的日期参数，例如格式：Y-m-d H:i:s |
| 10 | GET/POST | App.Examples_Rule.DateTimestamp | 参数示例 - 时间戳日期参数 | 时间戳日期参数，输入日期字符串参数，如传：2019-03-01 00:00:00，接口接收后会转成：1551369600。 |
| 11 | GET/POST | App.Examples_Rule.SexEnum | 参数示例 - 枚举参数 | 例如，男或女的性别参数。 |
| 12 | GET/POST | App.Examples_Rule.RegexStr | 参数示例 - 正则字符串参数 | 指定正则的字符串参数 |
| 13 | GET/POST | App.Examples_Rule.VersionCallback | 参数示例 - 版本回调参数 | 回调类型的参数，可以自定义参数的检测、转换和校验逻辑。例如版本号。 |
| 14 | GET/POST | App.Examples_Rule.StatusEnum | 参数示例 - 状态枚举参数 | 对于是数值的枚举范围，注意配置时请用字符串类型。 |
| 15 | GET/POST | App.Examples_Rule.DefaultStr | 参数示例 - 默认且必须的字符串参数 | 带默认值，并且为必须的字符串参数。默认是string类型，所以一般不用配置type为string。 |
| 16 | GET/POST | App.Examples_Response.Debug | 展示调试相关能力 | 使用前请开启调试模式，效果更佳 |
| 17 | GET/POST | App.Examples_DataApi.DeleteDataIDs | 批量删除 | 通用数据接口，根据ID批量删除数据 |
| 18 | GET/POST | App.Examples_CURD.Delete | 数据库示例 - 删除数据 | 根据ID删除数据库中的一条纪录数据 |
| 19 | GET/POST | App.Examples_CURD.Insert | 数据库示例 - 插入数据 | 向数据库插入一条纪录数据 |
| 20 | POST | App.Examples_CURD.Update | 数据库示例 - 更新数据 | 根据ID更新数据库中的一条纪录数据 |
| 21 | GET/POST | App.Examples_CURD.SqlDebug | 数据库示例 - 演示如何进行SQL调试和相关的使用 | 除此接口外，其他示例也可进行在线调试。本示例将便详细说明如何调试。 |
| 22 | GET/POST | App.Examples_CURD.GetList | 数据库示例 - 获取分页列表数据 | 根据状态筛选列表数据，支持分页 |
| 23 | GET | App.Examples_CURD.Get | 数据库示例 - 获取数据 | 根据ID获取数据库中的一条纪录数据 |
| 24 | POST | App.Examples_Upload.Go | 文件上传 - 图片文件上传 | 只能上传单个图片文件 |
| 25 | GET | App.Examples_Docs.Usage | 文档示例 - 接口文档使用示例 | 接口说明，更多使用请参考官方文档http://docs.phalapi.net/#/v2.0/api-docs |
| 26 | GET/POST | App.Examples_Log.Run | 日记 - 写入日志 | 演示日志操作，包括写系统异常类日志、业务纪录类日志、开发调试类日志 |
| 27 | GET/POST | App.Examples_DataApi.UpdateData | 更新数据 | 通用数据接口，根据ID更新单条数据 |
| 28 | GET/POST | App.Examples_DataApi.DeleteData | 根据ID删除数据 | 根据单个ID删除数据，也可以调整成根据自定义的条件删除数据 |
| 29 | GET/POST | App.Examples_Response.TopResult | 演示在返回结果根节点添加额外的字段返回 | 自定义动态返回JSON根节点，增加最外层返回消息，例如最外层的【status 状态码】和【time 当前系统时间】 |
| 30 | GET/POST | App.Examples_DataApi.GetData | 获取一条数据 | 通用数据接口，根据ID获取一条数据 |
| 31 | GET/POST | App.Examples_DataApi.TableList | 获取表格列表数据 | 通用数据接口，获取表格列表数据，默认按ID降序返回，支持分页和搜索 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.Permission.CheckButtonPermission | 检查按钮权限 | 检查当前用户是否有指定按钮权限 |
| 2 | GET/POST | App.Permission.CheckPermission | 检查权限 | 检查当前用户是否有指定权限 |
| 3 | GET/POST | App.Permission.GetTree | 获取权限树 | 获取权限树结构 |
| 4 | GET/POST | App.Permission.GetUserButtons | 获取用户按钮权限 | 获取当前用户在指定菜单下可操作的按钮 |
| 5 | GET/POST | App.Permission.GetUserMenus | 获取用户菜单 | 获取当前用户可访问的菜单 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.Tenant.UpdateInfo | 更新租户信息 | 更新租户基础信息（联系人、电话、地址） |
| 2 | GET/POST | App.Tenant.GetAuditStatus | 查询审核状态 | 根据申请编号查询审核状态 |
| 3 | GET/POST | App.Tenant.Register | 租户注册申请 | 门店提交注册申请，等待平台审核 |
| 4 | GET/POST | App.Tenant.GetInfo | 获取租户信息 | 获取当前登录租户的基础信息 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.Platform_Role.AssignPermissions | 分配权限 | 为平台角色分配权限 |
| 2 | GET/POST | App.Platform_Role.Create | 创建平台角色 | 创建平台端角色 |
| 3 | GET/POST | App.Platform_Role.Delete | 删除平台角色 | 删除平台端角色 |
| 4 | GET/POST | App.Platform_Role.Update | 更新平台角色 | 更新平台端角色信息 |
| 5 | GET/POST | App.Platform_Role.GetList | 获取平台角色列表 | 获取平台端角色列表 |
| 6 | GET/POST | App.Platform_Role.GetInfo | 获取平台角色详情 | 获取平台角色详细信息 |
| 7 | GET/POST | App.Platform_Role.GetPermissions | 获取角色权限 | 获取平台角色已分配的权限 |
| 8 | GET/POST | App.Platform_Role.SetStatus | 设置角色状态 | 启用或禁用平台角色 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.Role.AssignPermissions | 分配权限 | 为角色分配权限 |
| 2 | GET/POST | App.Role.Create | 创建角色 | 创建租户角色 |
| 3 | GET/POST | App.Role.Delete | 删除角色 | 删除租户角色 |
| 4 | GET/POST | App.Role.Update | 更新角色 | 更新租户角色信息 |
| 5 | GET/POST | App.Role.GetList | 获取角色列表 | 获取租户角色列表 |
| 6 | GET/POST | App.Role.GetPermissions | 获取角色权限 | 获取角色已分配的权限 |
| 7 | GET/POST | App.Role.GetInfo | 获取角色详情 | 获取角色详细信息 |
| 8 | GET/POST | App.Role.SetStatus | 设置角色状态 | 启用或禁用角色 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.Auth.RefreshPermissions | 刷新权限 | 刷新当前用户的权限缓存 |
| 2 | GET/POST | App.Auth.Login | 员工登录 | 员工账号登录 |
| 3 | GET/POST | App.Auth.Logout | 登出 | 退出登录 |
| 4 | GET/POST | App.Auth.ValidateToken | 验证Token | 验证Token是否有效 |
A PHP framework foucs on API fast development.
© 2015-2026 Powered By PhalApi API Framework 2.23.0
专业版