PhalApi开源接口框架 - 在线接口文档

#	请求方式	接口服务	接口名称	接口描述
1	GET/POST	App.Hello.World	示例接口	//请使用@desc 注释
2	GET/POST	App.Announcement.Delete	删除公告	删除公告，需要管理员权限
3	GET/POST	App.Announcement.Update	更新公告	更新公告信息，需要管理员权限
4	GET/POST	App.Announcement.Add	添加公告	添加新的公告，需要管理员权限
5	GET/POST	App.Announcement.GetList	获取公告列表	获取公告列表，支持分页和状态筛选
6	GET/POST	App.Property.UploadImage	上传房源图片	上传房源图片
7	GET/POST	App.Property.Create	创建房源	房东发布新房源
8	GET/POST	App.Property.CreatePaymentOrder	创建支付订单	创建房源发布支付订单
9	GET/POST	App.Property.Delete	删除房源	删除房源
10	GET/POST	App.Property.Search	搜索房源	搜索房源列表
11	GET/POST	App.Property.CreateWithPayment	支付后创建房源	支付成功后创建房源
12	GET/POST	App.Property.Update	更新房源	更新房源信息
13	GET/POST	App.Property.GetOrderStatus	查询订单状态	查询支付订单状态
14	GET/POST	App.Property.GetMyList	获取我的房源列表	房东获取自己的房源列表
15	GET/POST	App.Property.GetMyOrders	获取我的订单列表	获取用户的支付订单列表
16	GET/POST	App.Property.GetDetail	获取房源详情	获取房源详细信息
17	GET/POST	App.Property.SetStatus	设置房源状态	上架/下架房源
18	GET/POST	App.Examples_QrCode.Png	二维码 - 根据文本内容，生成二维码	可根据传入的文本内容，生成对应的二维码，还可以调整尺寸大小。可以直接输出png图片，也可以返回base64后的图片数据。
19	GET/POST	App.Examples_DataApi.CreateData	创建新数据	通用数据接口，创建一条新数据
20	GET/POST	App.Examples_Rule.JsonArray	参数示例 - JSON数组参数	演示如何配置JSON格式的数组参数，并原路返回。
21	GET/POST	App.Examples_Rule.ExplodeArray	参数示例 - 分割的数组参数	以英文逗号分割的数组，并且可以设置数组个数。
22	GET/POST	App.Examples_Rule.Str	参数示例 - 字符串参数	简单的字符串参数
23	GET/POST	App.Examples_Rule.TrueOrFalse	参数示例 - 开关参数	true或false的开关参数。
24	GET/POST	App.Examples_Rule.RangeNumber	参数示例 - 指定范围的整数参数	指定范围的整数参数，可以设置最小值、最大值，当设定默认值时，对客户端则不是必传参数。
25	GET/POST	App.Examples_Rule.Number	参数示例 - 整数参数	必须的整数参数
26	GET/POST	App.Examples_Rule.DateStr	参数示例 - 日期参数	字符串的日期参数，例如格式：Y-m-d H:i:s
27	GET/POST	App.Examples_Rule.DateTimestamp	参数示例 - 时间戳日期参数	时间戳日期参数，输入日期字符串参数，如传：2019-03-01 00:00:00，接口接收后会转成：1551369600。
28	GET/POST	App.Examples_Rule.SexEnum	参数示例 - 枚举参数	例如，男或女的性别参数。
29	GET/POST	App.Examples_Rule.RegexStr	参数示例 - 正则字符串参数	指定正则的字符串参数
30	GET/POST	App.Examples_Rule.VersionCallback	参数示例 - 版本回调参数	回调类型的参数，可以自定义参数的检测、转换和校验逻辑。例如版本号。
31	GET/POST	App.Examples_Rule.StatusEnum	参数示例 - 状态枚举参数	对于是数值的枚举范围，注意配置时请用字符串类型。
32	GET/POST	App.Examples_Rule.DefaultStr	参数示例 - 默认且必须的字符串参数	带默认值，并且为必须的字符串参数。默认是string类型，所以一般不用配置type为string。
33	GET/POST	App.Examples_Response.Debug	展示调试相关能力	使用前请开启调试模式，效果更佳
34	GET/POST	App.Examples_DataApi.DeleteDataIDs	批量删除	通用数据接口，根据ID批量删除数据
35	GET/POST	App.Examples_CURD.Delete	数据库示例 - 删除数据	根据ID删除数据库中的一条纪录数据
36	GET/POST	App.Examples_CURD.Insert	数据库示例 - 插入数据	向数据库插入一条纪录数据
37	POST	App.Examples_CURD.Update	数据库示例 - 更新数据	根据ID更新数据库中的一条纪录数据
38	GET/POST	App.Examples_CURD.SqlDebug	数据库示例 - 演示如何进行SQL调试和相关的使用	除此接口外，其他示例也可进行在线调试。本示例将便详细说明如何调试。
39	GET/POST	App.Examples_CURD.GetList	数据库示例 - 获取分页列表数据	根据状态筛选列表数据，支持分页
40	GET	App.Examples_CURD.Get	数据库示例 - 获取数据	根据ID获取数据库中的一条纪录数据
41	POST	App.Examples_Upload.Go	文件上传 - 图片文件上传	只能上传单个图片文件
42	GET	App.Examples_Docs.Usage	文档示例 - 接口文档使用示例	接口说明，更多使用请参考官方文档http://docs.phalapi.net/#/v2.0/api-docs
43	GET/POST	App.Examples_Log.Run	日记 - 写入日志	演示日志操作，包括写系统异常类日志、业务纪录类日志、开发调试类日志
44	GET/POST	App.Examples_DataApi.UpdateData	更新数据	通用数据接口，根据ID更新单条数据
45	GET/POST	App.Examples_DataApi.DeleteData	根据ID删除数据	根据单个ID删除数据，也可以调整成根据自定义的条件删除数据
46	GET/POST	App.Examples_Response.TopResult	演示在返回结果根节点添加额外的字段返回	自定义动态返回JSON根节点，增加最外层返回消息，例如最外层的【status 状态码】和【time 当前系统时间】
47	GET/POST	App.Examples_DataApi.GetData	获取一条数据	通用数据接口，根据ID获取一条数据
48	GET/POST	App.Examples_DataApi.TableList	获取表格列表数据	通用数据接口，获取表格列表数据，默认按ID降序返回，支持分页和搜索
49	GET/POST	App.Payment.WechatNotify	微信支付回调	处理微信支付异步通知
50	GET/POST	App.Favorite.Remove	取消收藏	取消收藏房源
51	GET/POST	App.Favorite.Check	检查是否已收藏	检查房源是否已收藏
52	GET/POST	App.Favorite.Add	添加收藏	收藏房源
53	GET/POST	App.Favorite.GetList	获取收藏列表	获取我的收藏列表
54	GET/POST	App.User.ChangePassword	修改密码	修改登录密码
55	GET/POST	App.User.SendSmsCode	发送短信验证码	发送短信验证码
56	GET/POST	App.User.WxLogin	微信登录	使用微信code登录
57	GET/POST	App.User.SubmitVerification	提交实名认证	房东提交实名认证信息
58	GET/POST	App.User.UpdateProfile	更新用户信息	更新用户基本信息
59	GET/POST	App.User.Register	用户注册	新用户注册接口
60	GET/POST	App.User.Login	用户登录	支持密码登录和验证码登录
61	GET/POST	App.User.GetProfile	获取用户信息	获取当前登录用户信息
62	GET/POST	App.User.ResetPassword	重置密码	通过短信验证码重置密码
63	GET/POST	App.Admin.UploadMiniProgram	上传小程序代码	使用miniprogram-ci上传小程序代码
64	GET/POST	App.Admin.UploadPaymentCert	上传支付证书	上传微信支付API证书文件
65	GET/POST	App.Admin.FreezeUser	冻结/解冻用户	冻结或解冻用户账号
66	GET/POST	App.Admin.ToggleOperator	切换操作员状态	启用或禁用操作员
67	GET/POST	App.Admin.DeleteCity	删除城市	删除城市/区县/商圈
68	GET/POST	App.Admin.DeleteProperty	删除房源	管理员删除房源
69	GET/POST	App.Admin.DeleteOperator	删除操作员	删除操作员
70	GET/POST	App.Admin.DeleteKeyword	删除敏感词	删除敏感词
71	GET/POST	App.Admin.HandleReport	处理举报	处理举报
72	GET/POST	App.Admin.ReviewVerification	审核实名认证	审核实名认证通过或失败
73	GET/POST	App.Admin.ReviewProperty	审核房源	审核房源通过或驳回
74	GET/POST	App.Admin.ExportData	导出数据	导出数据
75	GET/POST	App.Admin.UpdateConfigBatch	批量更新配置	批量更新系统配置
76	GET/POST	App.Admin.UpdateCity	更新城市	更新城市/区县/商圈
77	GET/POST	App.Admin.UpdateProperty	更新房源	管理员更新房源
78	GET/POST	App.Admin.UpdateOperator	更新操作员	更新操作员信息
79	GET/POST	App.Admin.UpdatePaymentConfig	更新支付配置	更新支付相关配置
80	GET/POST	App.Admin.UpdateConfig	更新配置	更新系统配置
81	GET/POST	App.Admin.CheckMpEnvironment	检测小程序上传环境	检测服务器是否支持小程序上传
82	GET/POST	App.Admin.AddCity	添加城市	添加城市/区县/商圈
83	GET/POST	App.Admin.AddProperty	添加房源	管理员添加房源
84	GET/POST	App.Admin.AddOperator	添加操作员	添加新操作员
85	GET/POST	App.Admin.AddKeyword	添加敏感词	添加敏感词
86	GET/POST	App.Admin.PreviewMiniProgram	生成小程序预览	使用miniprogram-ci生成预览二维码
87	GET/POST	App.Admin.GetUploadHistory	获取上传记录	获取小程序上传历史记录
88	GET/POST	App.Admin.GetCityList	获取城市列表	获取城市/区县/商圈列表
89	GET/POST	App.Admin.GetPendingReports	获取待处理举报列表	获取待处理的举报列表
90	GET/POST	App.Admin.GetPendingVerifications	获取待审核实名认证列表	获取待审核的实名认证列表
91	GET/POST	App.Admin.GetPendingProperties	获取待审核房源列表	获取待审核的房源列表
92	GET/POST	App.Admin.GetPropertyList	获取房源列表	获取房源列表（管理员）
93	GET/POST	App.Admin.GetProperty	获取房源详情	获取单个房源信息
94	GET/POST	App.Admin.GetOperatorList	获取操作员列表	获取操作员列表
95	GET/POST	App.Admin.GetOperator	获取操作员详情	获取单个操作员信息
96	GET/POST	App.Admin.GetPaymentOrders	获取支付订单列表	获取支付订单列表（管理员）
97	GET/POST	App.Admin.GetPaymentConfig	获取支付配置	获取支付相关配置
98	GET/POST	App.Admin.GetKeywordList	获取敏感词列表	获取敏感词列表
99	GET/POST	App.Admin.GetUserList	获取用户列表	获取用户列表（管理员）
100	GET/POST	App.Admin.GetStatistics	获取统计数据	获取平台统计数据
101	GET/POST	App.Admin.GetConfig	获取配置	获取系统配置
102	GET/POST	App.Admin.RefundOrder	退款	管理员退款操作
103	GET/POST	App.Stats.GetCube	获取魔方统计数据	获取首页魔方展示的统计数据
104	GET/POST	App.Chat.Create	创建会话	创建或获取与房东的聊天会话
105	GET/POST	App.Chat.SendMessage	发送消息	发送聊天消息
106	GET/POST	App.Chat.GetChatList	获取会话列表	获取我的聊天会话列表
107	GET/POST	App.Chat.GetUnreadCount	获取未读消息数	获取总未读消息数
108	GET/POST	App.Chat.GetMessages	获取消息列表	获取会话消息列表
109	GET/POST	App.Banner.Delete	删除轮播图	删除轮播图，需要管理员权限
110	GET/POST	App.Banner.Update	更新轮播图	更新轮播图信息，需要管理员权限
111	GET/POST	App.Banner.Add	添加轮播图	添加新的轮播图，需要管理员权限
112	GET/POST	App.Banner.GetList	获取轮播图列表	获取轮播图列表，支持分页和状态筛选
113	GET/POST	App.Appointment.Create	创建预约	租客发起看房预约
114	GET/POST	App.Appointment.Cancel	取消预约	取消预约
115	GET/POST	App.Appointment.Respond	响应预约	房东响应预约请求
116	GET/POST	App.Appointment.GetMyList	获取我发起的预约列表	租客获取自己发起的预约列表
117	GET/POST	App.Appointment.GetReceivedList	获取收到的预约列表	房东获取收到的预约列表
118	GET/POST	App.Home.GetData	获取首页数据	获取首页所有数据，包括轮播图、公告和统计数据

切换到折叠版

温馨提示： 此接口文档根据接口代码和注释实时自动生成，可在接口类的文件注释的第一行修改左侧菜单标题。