phalapi PhalApi开源接口框架 首页 接口文档 开发文档
语言
简体中文 English
# 请求方式 接口服务 接口名称 接口描述
1GET/POSTApp.AdminBanner.Create//请检测函数注释//请使用@desc 注释
2GET/POSTApp.AdminBanner.Delete//请检测函数注释//请使用@desc 注释
3GET/POSTApp.AdminBanner.GetInfo//请检测函数注释//请使用@desc 注释
4GET/POSTApp.AdminBanner.GetList//请检测函数注释//请使用@desc 注释
5GET/POSTApp.AdminBanner.ToggleStatus//请检测函数注释//请使用@desc 注释
6GET/POSTApp.AdminBanner.Update//请检测函数注释//请使用@desc 注释
7GET/POSTApp.Hello.World示例接口//请使用@desc 注释
8GET/POSTApp.Upload.Image上传单张图片 上传单张图片,返回图片URL
9GET/POSTApp.Upload.Images上传多张图片 批量上传图片
10GET/POSTApp.Post.List信息列表 获取信息列表,支持多种筛选和排序
11GET/POSTApp.Post.Detail信息详情 获取信息详情,自动增加浏览量
12GET/POSTApp.Post.Delete删除信息 删除已发布的信息
13GET/POSTApp.Post.Refresh刷新信息 刷新信息,更新排序时间
14GET/POSTApp.Post.Create发布信息 发布招聘/商铺/二手等信息
15GET/POSTApp.Post.Update更新信息 更新已发布的信息
16GET/POSTApp.Post.SetTop置顶信息 设置信息置顶
17GET/POSTApp.Post.GetPublishConfig获取发布配置 获取发布时长选项、会员权益等配置
18GET/POSTApp.Post.GetTopConfig获取置顶配置 获取置顶时长选项和会员置顶权益
19GET/POSTApp.Category.GetList获取分类列表 获取指定类型或父级下的分类
20GET/POSTApp.Category.GetTree获取分类树 获取分类树形结构
21GET/POSTApp.Category.GetAll获取所有顶级分类 获取首页展示的所有顶级分类
22GET/POSTApp.Distribution.ApplyWithdraw申请提现 申请将佣金提现到账户
23GET/POSTApp.Distribution.BindInvite绑定邀请码 新用户绑定上级邀请码,建立分销关系
24GET/POSTApp.Distribution.GetCommissionList获取佣金记录 获取佣金收支记录
25GET/POSTApp.Distribution.GetTeamList获取团队列表 获取下级团队成员列表
26GET/POSTApp.Distribution.GetMyInfo获取我的分销信息 获取用户的分销信息,包括佣金、团队等
27GET/POSTApp.Distribution.GetWithdrawList获取提现记录 获取提现历史记录
28GET/POSTApp.AdminAnnouncement.Create创建公告//请使用@desc 注释
29GET/POSTApp.AdminAnnouncement.Delete删除公告//请使用@desc 注释
30GET/POSTApp.AdminAnnouncement.Publish发布公告(发送通知给所有用户)//请使用@desc 注释
31GET/POSTApp.AdminAnnouncement.Update更新公告//请使用@desc 注释
32GET/POSTApp.AdminAnnouncement.GetList获取公告列表//请使用@desc 注释
33GET/POSTApp.AdminAnnouncement.Get获取公告详情//请使用@desc 注释
34GET/POSTApp.AdminDistribution.AuditWithdraw审核提现//请使用@desc 注释
35GET/POSTApp.AdminDistribution.UpdateConfig更新分销配置 更新分销系统配置
36GET/POSTApp.AdminDistribution.PayWithdraw标记已打款//请使用@desc 注释
37GET/POSTApp.AdminDistribution.GetCommissionList获取佣金记录//请使用@desc 注释
38GET/POSTApp.AdminDistribution.GetUserList获取分销用户列表//请使用@desc 注释
39GET/POSTApp.AdminDistribution.GetConfig获取分销配置 获取分销系统配置
40GET/POSTApp.AdminDistribution.GetWithdrawList获取提现列表//请使用@desc 注释
41GET/POSTApp.AdminDistribution.GetStats获取统计数据//请使用@desc 注释
42GET/POSTApp.Examples_QrCode.Png二维码 - 根据文本内容,生成二维码 可根据传入的文本内容,生成对应的二维码,还可以调整尺寸大小。可以直接输出png图片,也可以返回base64后的图片数据。
43GET/POSTApp.Examples_DataApi.CreateData创建新数据 通用数据接口,创建一条新数据
44GET/POSTApp.Examples_Rule.JsonArray参数示例 - JSON数组参数 演示如何配置JSON格式的数组参数,并原路返回。
45GET/POSTApp.Examples_Rule.ExplodeArray参数示例 - 分割的数组参数 以英文逗号分割的数组,并且可以设置数组个数。
46GET/POSTApp.Examples_Rule.Str参数示例 - 字符串参数 简单的字符串参数
47GET/POSTApp.Examples_Rule.TrueOrFalse参数示例 - 开关参数 true或false的开关参数。
48GET/POSTApp.Examples_Rule.RangeNumber参数示例 - 指定范围的整数参数 指定范围的整数参数,可以设置最小值、最大值,当设定默认值时,对客户端则不是必传参数。
49GET/POSTApp.Examples_Rule.Number参数示例 - 整数参数 必须的整数参数
50GET/POSTApp.Examples_Rule.DateStr参数示例 - 日期参数 字符串的日期参数,例如格式:Y-m-d H:i:s
51GET/POSTApp.Examples_Rule.DateTimestamp参数示例 - 时间戳日期参数 时间戳日期参数,输入日期字符串参数,如传:2019-03-01 00:00:00,接口接收后会转成:1551369600。
52GET/POSTApp.Examples_Rule.SexEnum参数示例 - 枚举参数 例如,男或女的性别参数。
53GET/POSTApp.Examples_Rule.RegexStr参数示例 - 正则字符串参数 指定正则的字符串参数
54GET/POSTApp.Examples_Rule.VersionCallback参数示例 - 版本回调参数 回调类型的参数,可以自定义参数的检测、转换和校验逻辑。例如版本号。
55GET/POSTApp.Examples_Rule.StatusEnum参数示例 - 状态枚举参数 对于是数值的枚举范围,注意配置时请用字符串类型。
56GET/POSTApp.Examples_Rule.DefaultStr参数示例 - 默认且必须的字符串参数 带默认值,并且为必须的字符串参数。默认是string类型,所以一般不用配置type为string。
57GET/POSTApp.Examples_Response.Debug展示调试相关能力 使用前请开启调试模式,效果更佳
58GET/POSTApp.Examples_DataApi.DeleteDataIDs批量删除 通用数据接口,根据ID批量删除数据
59GET/POSTApp.Examples_CURD.Delete数据库示例 - 删除数据 根据ID删除数据库中的一条纪录数据
60GET/POSTApp.Examples_CURD.Insert数据库示例 - 插入数据 向数据库插入一条纪录数据
61POSTApp.Examples_CURD.Update数据库示例 - 更新数据 根据ID更新数据库中的一条纪录数据
62GET/POSTApp.Examples_CURD.SqlDebug数据库示例 - 演示如何进行SQL调试和相关的使用 除此接口外,其他示例也可进行在线调试。本示例将便详细说明如何调试。
63GET/POSTApp.Examples_CURD.GetList数据库示例 - 获取分页列表数据 根据状态筛选列表数据,支持分页
64GETApp.Examples_CURD.Get数据库示例 - 获取数据 根据ID获取数据库中的一条纪录数据
65POSTApp.Examples_Upload.Go文件上传 - 图片文件上传 只能上传单个图片文件
66GETApp.Examples_Docs.Usage文档示例 - 接口文档使用示例 接口说明,更多使用请参考官方文档http://docs.phalapi.net/#/v2.0/api-docs
67GET/POSTApp.Examples_Log.Run日记 - 写入日志 演示日志操作,包括写系统异常类日志、业务纪录类日志、开发调试类日志
68GET/POSTApp.Examples_DataApi.UpdateData更新数据 通用数据接口,根据ID更新单条数据
69GET/POSTApp.Examples_DataApi.DeleteData根据ID删除数据 根据单个ID删除数据,也可以调整成根据自定义的条件删除数据
70GET/POSTApp.Examples_Response.TopResult演示在返回结果根节点添加额外的字段返回 自定义动态返回JSON根节点,增加最外层返回消息,例如最外层的【status 状态码】和【time 当前系统时间】
71GET/POSTApp.Examples_DataApi.GetData获取一条数据 通用数据接口,根据ID获取一条数据
72GET/POSTApp.Examples_DataApi.TableList获取表格列表数据 通用数据接口,获取表格列表数据,默认按ID降序返回,支持分页和搜索
73GET/POSTApp.Payment.CreateMemberOrder创建会员订单 创建会员购买订单
74GET/POSTApp.Payment.CreatePay发起支付 调用微信支付
75GET/POSTApp.Payment.GetMyOrders我的订单列表 获取我的订单列表
76GET/POSTApp.Favorite.Remove取消收藏 取消收藏一条信息
77GET/POSTApp.Favorite.List收藏列表 获取我的收藏列表
78GET/POSTApp.Favorite.Check检查是否已收藏 检查某条信息是否已收藏
79GET/POSTApp.Favorite.Add添加收藏 收藏一条信息
80GET/POSTApp.User.MpLogin微信公众号登录 微信公众号网页授权登录
81GET/POSTApp.User.WeixinLogin微信小程序登录 微信小程序授权登录
82GET/POSTApp.User.Login微信登录 通过微信code换取用户信息并登录
83GET/POSTApp.User.MyPosts我的发布 获取当前用户发布的信息列表
84GET/POSTApp.User.UpdateInfo更新用户信息 更新昵称、头像、手机号等
85GET/POSTApp.User.TestLogin测试登录(开发用) 通过手机号直接登录,用于开发测试
86GET/POSTApp.User.BindPhoneSimple简单绑定手机号(无需验证码) 直接输入手机号绑定,无需验证码
87GET/POSTApp.User.BindPhone绑定手机号 微信小程序绑定手机号
88GET/POSTApp.User.GetMemberInfo获取会员信息 获取当前用户的会员权益信息
89GET/POSTApp.User.GetMemberPlans获取会员套餐列表 获取所有可用的会员套餐
90GET/POSTApp.User.GetMpAuthUrl获取公众号授权URL 获取微信公众号网页授权URL
91GET/POSTApp.User.GetJssdkConfig获取微信JS-SDK配置 获取微信JS-SDK配置信息
92GET/POSTApp.User.GetInfo获取用户信息 获取当前登录用户信息
93GET/POSTApp.User.BuyMember购买会员 购买会员套餐
94GET/POSTApp.User.BindPhoneByWx通过微信快速验证绑定手机号 H5/公众号微信手机号快速验证
95GET/POSTApp.AdminReport.List举报列表//请使用@desc 注释
96GET/POSTApp.AdminReport.Handle处理举报//请使用@desc 注释
97GET/POSTApp.AdminMemberPlan.Create//请检测函数注释//请使用@desc 注释
98GET/POSTApp.AdminMemberPlan.Delete//请检测函数注释//请使用@desc 注释
99GET/POSTApp.AdminMemberPlan.Detail//请检测函数注释//请使用@desc 注释
100GET/POSTApp.AdminMemberPlan.List//请检测函数注释//请使用@desc 注释
101GET/POSTApp.AdminMemberPlan.Update//请检测函数注释//请使用@desc 注释
102GET/POSTApp.AdminPost.List信息列表//请使用@desc 注释
103GET/POSTApp.AdminPost.Detail信息详情//请使用@desc 注释
104GET/POSTApp.AdminPost.Delete删除信息//请使用@desc 注释
105GET/POSTApp.AdminPost.Create发布信息 后台发布信息,直接通过审核
106GET/POSTApp.AdminPost.Audit审核信息//请使用@desc 注释
107GET/POSTApp.AdminPost.BatchDelete批量删除//请使用@desc 注释
108GET/POSTApp.AdminPost.BatchAudit批量审核//请使用@desc 注释
109GET/POSTApp.AdminPost.Update编辑信息//请使用@desc 注释
110GET/POSTApp.AdminPost.SetStatus设置状态(上架/下架)//请使用@desc 注释
111GET/POSTApp.AdminPost.SetTop设置置顶//请使用@desc 注释
112GET/POSTApp.AdminCategory.List分类列表//请使用@desc 注释
113GET/POSTApp.AdminCategory.Tree分类树//请使用@desc 注释
114GET/POSTApp.AdminCategory.Create创建分类//请使用@desc 注释
115GET/POSTApp.AdminCategory.Delete删除分类//请使用@desc 注释
116GET/POSTApp.AdminCategory.Update更新分类//请使用@desc 注释
117GET/POSTApp.AdminWechatConfig.SaveMpConfig保存公众号配置 保存微信公众号配置信息
118GET/POSTApp.AdminWechatConfig.SaveMiniappConfig保存小程序配置 保存微信小程序配置信息
119GET/POSTApp.AdminWechatConfig.SavePaymentConfig保存支付配置 保存微信支付配置信息
120GET/POSTApp.AdminWechatConfig.GetMpConfig获取公众号配置 获取微信公众号配置信息
121GET/POSTApp.AdminWechatConfig.GetMiniappConfig获取小程序配置 获取微信小程序配置信息
122GET/POSTApp.AdminWechatConfig.GetPaymentConfig获取支付配置 获取微信支付配置信息
123GET/POSTApp.AdminPayment.SaveConfig保存支付配置//请使用@desc 注释
124GET/POSTApp.AdminPayment.GetConfig获取支付配置//请使用@desc 注释
125GET/POSTApp.AdminPayment.GetOrderList获取订单列表//请使用@desc 注释
126GET/POSTApp.AdminPayment.GetStats获取订单统计//请使用@desc 注释
127GET/POSTApp.AdminPayment.GetOrderDetail获取订单详情//请使用@desc 注释
128GET/POSTApp.AdminUser.Delete删除用户 删除用户及其所有相关数据
129GET/POSTApp.AdminUser.Update更新用户信息 修改用户会员套餐等信息
130GET/POSTApp.AdminUser.List用户列表//请使用@desc 注释
131GET/POSTApp.AdminUser.Detail用户详情//请使用@desc 注释
132GET/POSTApp.AdminUser.SetStatus设置用户状态 禁用/启用用户
133GET/POSTApp.Admin.UpdatePassword修改密码//请使用@desc 注释
134GET/POSTApp.Admin.Create创建管理员 仅超级管理员可用
135GET/POSTApp.Admin.Delete删除管理员 仅超级管理员可用
136GET/POSTApp.Admin.Update更新管理员 仅超级管理员可用
137GET/POSTApp.Admin.List管理员列表 仅超级管理员可用
138GET/POSTApp.Admin.Login管理员登录 管理员账号密码登录
139GET/POSTApp.Admin.GetDashboard获取仪表盘数据//请使用@desc 注释
140GET/POSTApp.Admin.GetInfo获取当前管理员信息//请使用@desc 注释
141GET/POSTApp.Admin.Logout退出登录//请使用@desc 注释
142GET/POSTApp.AdminConfig.UploadQrcode上传客服二维码//请使用@desc 注释
143GET/POSTApp.AdminConfig.SaveMemberBanner保存会员横幅配置//请使用@desc 注释
144GET/POSTApp.AdminConfig.SaveWechatMp保存公众号配置//请使用@desc 注释
145GET/POSTApp.AdminConfig.SaveConfig保存单个配置//请使用@desc 注释
146GET/POSTApp.AdminConfig.SaveService保存客服设置//请使用@desc 注释
147GET/POSTApp.AdminConfig.SaveMiniapp保存小程序配置//请使用@desc 注释
148GET/POSTApp.AdminConfig.SavePayment保存支付配置//请使用@desc 注释
149GET/POSTApp.AdminConfig.Save保存配置//请使用@desc 注释
150GET/POSTApp.AdminConfig.GetMemberBanner获取会员横幅配置//请使用@desc 注释
151GET/POSTApp.AdminConfig.GetWechatMp获取公众号配置//请使用@desc 注释
152GET/POSTApp.AdminConfig.GetConfig获取单个配置//请使用@desc 注释
153GET/POSTApp.AdminConfig.GetService获取客服设置//请使用@desc 注释
154GET/POSTApp.AdminConfig.GetMiniapp获取小程序配置//请使用@desc 注释
155GET/POSTApp.AdminConfig.GetAll获取所有配置 获取所有系统配置(按分组)
156GET/POSTApp.AdminConfig.GetGroup获取指定分组配置//请使用@desc 注释
157GET/POSTApp.AdminConfig.GetPayment获取支付配置//请使用@desc 注释
158GET/POSTApp.AdminTopDuration.Add//请检测函数注释//请使用@desc 注释
159GET/POSTApp.AdminTopDuration.Delete//请检测函数注释//请使用@desc 注释
160GET/POSTApp.AdminTopDuration.GetDetail//请检测函数注释//请使用@desc 注释
161GET/POSTApp.AdminTopDuration.GetList//请检测函数注释//请使用@desc 注释
162GET/POSTApp.AdminTopDuration.Update//请检测函数注释//请使用@desc 注释
163GET/POSTApp.Contact.Create创建联系方式//请使用@desc 注释
164GET/POSTApp.Contact.Delete删除联系方式//请使用@desc 注释
165GET/POSTApp.Contact.Update更新联系方式//请使用@desc 注释
166GET/POSTApp.Contact.Get获取单个联系方式//请使用@desc 注释
167GET/POSTApp.Contact.GetList获取联系方式列表//请使用@desc 注释
168GET/POSTApp.Contact.SetDefault设置默认联系方式//请使用@desc 注释
169GET/POSTApp.Common.Report举报信息 用户举报不良信息
170GET/POSTApp.Common.GetBanners获取轮播图列表 获取首页轮播图
171GET/POSTApp.Common.GetConfig获取配置 获取系统配置(公开配置)
172GET/POSTApp.Notification.MarkAllAsRead全部标记为已读 将所有通知标记为已读
173GET/POSTApp.Notification.Delete删除通知 删除指定的单条通知
174GET/POSTApp.Notification.MarkAsRead标记为已读 将指定的通知标记为已读
175GET/POSTApp.Notification.GetAnnouncements获取公告列表 获取已发布的公告列表(无需登录)
176GET/POSTApp.Notification.GetUnreadCount获取未读数量 获取未读通知的数量
177GET/POSTApp.Notification.GetList获取通知列表 获取用户的消息通知列表
切换到折叠版
温馨提示: 此接口文档根据接口代码和注释实时自动生成,可在接口类的文件注释的第一行修改左侧菜单标题。
PhalApi

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