| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.AdminBanner.Create | //请检测函数注释 | //请使用@desc 注释 |
| 2 | GET/POST | App.AdminBanner.Delete | //请检测函数注释 | //请使用@desc 注释 |
| 3 | GET/POST | App.AdminBanner.GetInfo | //请检测函数注释 | //请使用@desc 注释 |
| 4 | GET/POST | App.AdminBanner.GetList | //请检测函数注释 | //请使用@desc 注释 |
| 5 | GET/POST | App.AdminBanner.ToggleStatus | //请检测函数注释 | //请使用@desc 注释 |
| 6 | GET/POST | App.AdminBanner.Update | //请检测函数注释 | //请使用@desc 注释 |
| # | 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.Upload.Image | 上传单张图片 | 上传单张图片，返回图片URL |
| 2 | GET/POST | App.Upload.Images | 上传多张图片 | 批量上传图片 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.Post.List | 信息列表 | 获取信息列表，支持多种筛选和排序 |
| 2 | GET/POST | App.Post.Detail | 信息详情 | 获取信息详情，自动增加浏览量 |
| 3 | GET/POST | App.Post.Delete | 删除信息 | 删除已发布的信息 |
| 4 | GET/POST | App.Post.Refresh | 刷新信息 | 刷新信息，更新排序时间 |
| 5 | GET/POST | App.Post.Create | 发布信息 | 发布招聘/商铺/二手等信息 |
| 6 | GET/POST | App.Post.Update | 更新信息 | 更新已发布的信息 |
| 7 | GET/POST | App.Post.SetTop | 置顶信息 | 设置信息置顶 |
| 8 | GET/POST | App.Post.GetPublishConfig | 获取发布配置 | 获取发布时长选项、会员权益等配置 |
| 9 | GET/POST | App.Post.GetTopConfig | 获取置顶配置 | 获取置顶时长选项和会员置顶权益 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.Category.GetList | 获取分类列表 | 获取指定类型或父级下的分类 |
| 2 | GET/POST | App.Category.GetTree | 获取分类树 | 获取分类树形结构 |
| 3 | GET/POST | App.Category.GetAll | 获取所有顶级分类 | 获取首页展示的所有顶级分类 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.Distribution.ApplyWithdraw | 申请提现 | 申请将佣金提现到账户 |
| 2 | GET/POST | App.Distribution.BindInvite | 绑定邀请码 | 新用户绑定上级邀请码，建立分销关系 |
| 3 | GET/POST | App.Distribution.GetCommissionList | 获取佣金记录 | 获取佣金收支记录 |
| 4 | GET/POST | App.Distribution.GetTeamList | 获取团队列表 | 获取下级团队成员列表 |
| 5 | GET/POST | App.Distribution.GetMyInfo | 获取我的分销信息 | 获取用户的分销信息，包括佣金、团队等 |
| 6 | GET/POST | App.Distribution.GetWithdrawList | 获取提现记录 | 获取提现历史记录 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.AdminAnnouncement.Create | 创建公告 | //请使用@desc 注释 |
| 2 | GET/POST | App.AdminAnnouncement.Delete | 删除公告 | //请使用@desc 注释 |
| 3 | GET/POST | App.AdminAnnouncement.Publish | 发布公告（发送通知给所有用户） | //请使用@desc 注释 |
| 4 | GET/POST | App.AdminAnnouncement.Update | 更新公告 | //请使用@desc 注释 |
| 5 | GET/POST | App.AdminAnnouncement.GetList | 获取公告列表 | //请使用@desc 注释 |
| 6 | GET/POST | App.AdminAnnouncement.Get | 获取公告详情 | //请使用@desc 注释 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.AdminDistribution.AuditWithdraw | 审核提现 | //请使用@desc 注释 |
| 2 | GET/POST | App.AdminDistribution.UpdateConfig | 更新分销配置 | 更新分销系统配置 |
| 3 | GET/POST | App.AdminDistribution.PayWithdraw | 标记已打款 | //请使用@desc 注释 |
| 4 | GET/POST | App.AdminDistribution.GetCommissionList | 获取佣金记录 | //请使用@desc 注释 |
| 5 | GET/POST | App.AdminDistribution.GetUserList | 获取分销用户列表 | //请使用@desc 注释 |
| 6 | GET/POST | App.AdminDistribution.GetConfig | 获取分销配置 | 获取分销系统配置 |
| 7 | GET/POST | App.AdminDistribution.GetWithdrawList | 获取提现列表 | //请使用@desc 注释 |
| 8 | GET/POST | App.AdminDistribution.GetStats | 获取统计数据 | //请使用@desc 注释 |
| # | 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.Payment.CreateMemberOrder | 创建会员订单 | 创建会员购买订单 |
| 2 | GET/POST | App.Payment.CreatePay | 发起支付 | 调用微信支付 |
| 3 | GET/POST | App.Payment.GetMyOrders | 我的订单列表 | 获取我的订单列表 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.Favorite.Remove | 取消收藏 | 取消收藏一条信息 |
| 2 | GET/POST | App.Favorite.List | 收藏列表 | 获取我的收藏列表 |
| 3 | GET/POST | App.Favorite.Check | 检查是否已收藏 | 检查某条信息是否已收藏 |
| 4 | GET/POST | App.Favorite.Add | 添加收藏 | 收藏一条信息 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.User.MpLogin | 微信公众号登录 | 微信公众号网页授权登录 |
| 2 | GET/POST | App.User.WeixinLogin | 微信小程序登录 | 微信小程序授权登录 |
| 3 | GET/POST | App.User.Login | 微信登录 | 通过微信code换取用户信息并登录 |
| 4 | GET/POST | App.User.MyPosts | 我的发布 | 获取当前用户发布的信息列表 |
| 5 | GET/POST | App.User.UpdateInfo | 更新用户信息 | 更新昵称、头像、手机号等 |
| 6 | GET/POST | App.User.TestLogin | 测试登录（开发用） | 通过手机号直接登录，用于开发测试 |
| 7 | GET/POST | App.User.BindPhoneSimple | 简单绑定手机号（无需验证码） | 直接输入手机号绑定，无需验证码 |
| 8 | GET/POST | App.User.BindPhone | 绑定手机号 | 微信小程序绑定手机号 |
| 9 | GET/POST | App.User.GetMemberInfo | 获取会员信息 | 获取当前用户的会员权益信息 |
| 10 | GET/POST | App.User.GetMemberPlans | 获取会员套餐列表 | 获取所有可用的会员套餐 |
| 11 | GET/POST | App.User.GetMpAuthUrl | 获取公众号授权URL | 获取微信公众号网页授权URL |
| 12 | GET/POST | App.User.GetJssdkConfig | 获取微信JS-SDK配置 | 获取微信JS-SDK配置信息 |
| 13 | GET/POST | App.User.GetInfo | 获取用户信息 | 获取当前登录用户信息 |
| 14 | GET/POST | App.User.BuyMember | 购买会员 | 购买会员套餐 |
| 15 | GET/POST | App.User.BindPhoneByWx | 通过微信快速验证绑定手机号 | H5/公众号微信手机号快速验证 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.AdminReport.List | 举报列表 | //请使用@desc 注释 |
| 2 | GET/POST | App.AdminReport.Handle | 处理举报 | //请使用@desc 注释 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.AdminMemberPlan.Create | //请检测函数注释 | //请使用@desc 注释 |
| 2 | GET/POST | App.AdminMemberPlan.Delete | //请检测函数注释 | //请使用@desc 注释 |
| 3 | GET/POST | App.AdminMemberPlan.Detail | //请检测函数注释 | //请使用@desc 注释 |
| 4 | GET/POST | App.AdminMemberPlan.List | //请检测函数注释 | //请使用@desc 注释 |
| 5 | GET/POST | App.AdminMemberPlan.Update | //请检测函数注释 | //请使用@desc 注释 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.AdminPost.List | 信息列表 | //请使用@desc 注释 |
| 2 | GET/POST | App.AdminPost.Detail | 信息详情 | //请使用@desc 注释 |
| 3 | GET/POST | App.AdminPost.Delete | 删除信息 | //请使用@desc 注释 |
| 4 | GET/POST | App.AdminPost.Create | 发布信息 | 后台发布信息，直接通过审核 |
| 5 | GET/POST | App.AdminPost.Audit | 审核信息 | //请使用@desc 注释 |
| 6 | GET/POST | App.AdminPost.BatchDelete | 批量删除 | //请使用@desc 注释 |
| 7 | GET/POST | App.AdminPost.BatchAudit | 批量审核 | //请使用@desc 注释 |
| 8 | GET/POST | App.AdminPost.Update | 编辑信息 | //请使用@desc 注释 |
| 9 | GET/POST | App.AdminPost.SetStatus | 设置状态（上架/下架） | //请使用@desc 注释 |
| 10 | GET/POST | App.AdminPost.SetTop | 设置置顶 | //请使用@desc 注释 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.AdminCategory.List | 分类列表 | //请使用@desc 注释 |
| 2 | GET/POST | App.AdminCategory.Tree | 分类树 | //请使用@desc 注释 |
| 3 | GET/POST | App.AdminCategory.Create | 创建分类 | //请使用@desc 注释 |
| 4 | GET/POST | App.AdminCategory.Delete | 删除分类 | //请使用@desc 注释 |
| 5 | GET/POST | App.AdminCategory.Update | 更新分类 | //请使用@desc 注释 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.AdminWechatConfig.SaveMpConfig | 保存公众号配置 | 保存微信公众号配置信息 |
| 2 | GET/POST | App.AdminWechatConfig.SaveMiniappConfig | 保存小程序配置 | 保存微信小程序配置信息 |
| 3 | GET/POST | App.AdminWechatConfig.SavePaymentConfig | 保存支付配置 | 保存微信支付配置信息 |
| 4 | GET/POST | App.AdminWechatConfig.GetMpConfig | 获取公众号配置 | 获取微信公众号配置信息 |
| 5 | GET/POST | App.AdminWechatConfig.GetMiniappConfig | 获取小程序配置 | 获取微信小程序配置信息 |
| 6 | GET/POST | App.AdminWechatConfig.GetPaymentConfig | 获取支付配置 | 获取微信支付配置信息 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.AdminPayment.SaveConfig | 保存支付配置 | //请使用@desc 注释 |
| 2 | GET/POST | App.AdminPayment.GetConfig | 获取支付配置 | //请使用@desc 注释 |
| 3 | GET/POST | App.AdminPayment.GetOrderList | 获取订单列表 | //请使用@desc 注释 |
| 4 | GET/POST | App.AdminPayment.GetStats | 获取订单统计 | //请使用@desc 注释 |
| 5 | GET/POST | App.AdminPayment.GetOrderDetail | 获取订单详情 | //请使用@desc 注释 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.AdminUser.Delete | 删除用户 | 删除用户及其所有相关数据 |
| 2 | GET/POST | App.AdminUser.Update | 更新用户信息 | 修改用户会员套餐等信息 |
| 3 | GET/POST | App.AdminUser.List | 用户列表 | //请使用@desc 注释 |
| 4 | GET/POST | App.AdminUser.Detail | 用户详情 | //请使用@desc 注释 |
| 5 | GET/POST | App.AdminUser.SetStatus | 设置用户状态 | 禁用/启用用户 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.Admin.UpdatePassword | 修改密码 | //请使用@desc 注释 |
| 2 | GET/POST | App.Admin.Create | 创建管理员 | 仅超级管理员可用 |
| 3 | GET/POST | App.Admin.Delete | 删除管理员 | 仅超级管理员可用 |
| 4 | GET/POST | App.Admin.Update | 更新管理员 | 仅超级管理员可用 |
| 5 | GET/POST | App.Admin.List | 管理员列表 | 仅超级管理员可用 |
| 6 | GET/POST | App.Admin.Login | 管理员登录 | 管理员账号密码登录 |
| 7 | GET/POST | App.Admin.GetDashboard | 获取仪表盘数据 | //请使用@desc 注释 |
| 8 | GET/POST | App.Admin.GetInfo | 获取当前管理员信息 | //请使用@desc 注释 |
| 9 | GET/POST | App.Admin.Logout | 退出登录 | //请使用@desc 注释 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.AdminConfig.UploadQrcode | 上传客服二维码 | //请使用@desc 注释 |
| 2 | GET/POST | App.AdminConfig.SaveMemberBanner | 保存会员横幅配置 | //请使用@desc 注释 |
| 3 | GET/POST | App.AdminConfig.SaveWechatMp | 保存公众号配置 | //请使用@desc 注释 |
| 4 | GET/POST | App.AdminConfig.SaveConfig | 保存单个配置 | //请使用@desc 注释 |
| 5 | GET/POST | App.AdminConfig.SaveService | 保存客服设置 | //请使用@desc 注释 |
| 6 | GET/POST | App.AdminConfig.SaveMiniapp | 保存小程序配置 | //请使用@desc 注释 |
| 7 | GET/POST | App.AdminConfig.SavePayment | 保存支付配置 | //请使用@desc 注释 |
| 8 | GET/POST | App.AdminConfig.Save | 保存配置 | //请使用@desc 注释 |
| 9 | GET/POST | App.AdminConfig.GetMemberBanner | 获取会员横幅配置 | //请使用@desc 注释 |
| 10 | GET/POST | App.AdminConfig.GetWechatMp | 获取公众号配置 | //请使用@desc 注释 |
| 11 | GET/POST | App.AdminConfig.GetConfig | 获取单个配置 | //请使用@desc 注释 |
| 12 | GET/POST | App.AdminConfig.GetService | 获取客服设置 | //请使用@desc 注释 |
| 13 | GET/POST | App.AdminConfig.GetMiniapp | 获取小程序配置 | //请使用@desc 注释 |
| 14 | GET/POST | App.AdminConfig.GetAll | 获取所有配置 | 获取所有系统配置（按分组） |
| 15 | GET/POST | App.AdminConfig.GetGroup | 获取指定分组配置 | //请使用@desc 注释 |
| 16 | GET/POST | App.AdminConfig.GetPayment | 获取支付配置 | //请使用@desc 注释 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.AdminTopDuration.Add | //请检测函数注释 | //请使用@desc 注释 |
| 2 | GET/POST | App.AdminTopDuration.Delete | //请检测函数注释 | //请使用@desc 注释 |
| 3 | GET/POST | App.AdminTopDuration.GetDetail | //请检测函数注释 | //请使用@desc 注释 |
| 4 | GET/POST | App.AdminTopDuration.GetList | //请检测函数注释 | //请使用@desc 注释 |
| 5 | GET/POST | App.AdminTopDuration.Update | //请检测函数注释 | //请使用@desc 注释 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.Contact.Create | 创建联系方式 | //请使用@desc 注释 |
| 2 | GET/POST | App.Contact.Delete | 删除联系方式 | //请使用@desc 注释 |
| 3 | GET/POST | App.Contact.Update | 更新联系方式 | //请使用@desc 注释 |
| 4 | GET/POST | App.Contact.Get | 获取单个联系方式 | //请使用@desc 注释 |
| 5 | GET/POST | App.Contact.GetList | 获取联系方式列表 | //请使用@desc 注释 |
| 6 | GET/POST | App.Contact.SetDefault | 设置默认联系方式 | //请使用@desc 注释 |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.Common.Report | 举报信息 | 用户举报不良信息 |
| 2 | GET/POST | App.Common.GetBanners | 获取轮播图列表 | 获取首页轮播图 |
| 3 | GET/POST | App.Common.GetConfig | 获取配置 | 获取系统配置（公开配置） |
| # | Request Method | API Service | API Name | API Description |
|---|---|---|---|---|
| 1 | GET/POST | App.Notification.MarkAllAsRead | 全部标记为已读 | 将所有通知标记为已读 |
| 2 | GET/POST | App.Notification.Delete | 删除通知 | 删除指定的单条通知 |
| 3 | GET/POST | App.Notification.MarkAsRead | 标记为已读 | 将指定的通知标记为已读 |
| 4 | GET/POST | App.Notification.GetAnnouncements | 获取公告列表 | 获取已发布的公告列表（无需登录） |
| 5 | GET/POST | App.Notification.GetUnreadCount | 获取未读数量 | 获取未读通知的数量 |
| 6 | GET/POST | App.Notification.GetList | 获取通知列表 | 获取用户的消息通知列表 |
A PHP framework foucs on API fast development.
© 2015-2026 Powered By PhalApi API Framework 2.23.0
专业版