phalapi PhalApi开源接口框架 首页 接口文档 开发文档
语言
简体中文 English
# 请求方式 接口服务 接口名称 接口描述
1GET/POSTApp.Hello.World示例接口//请使用@desc 注释
2GET/POSTApp.Upload.Image上传单张图片 上传单张图片,返回图片URL
3GET/POSTApp.Upload.Images上传多张图片 批量上传图片
4GET/POSTApp.Post.List信息列表 获取信息列表,支持多种筛选和排序
5GET/POSTApp.Post.Detail信息详情 获取信息详情,自动增加浏览量
6GET/POSTApp.Post.Delete删除信息 删除已发布的信息
7GET/POSTApp.Post.Refresh刷新信息 刷新信息,更新排序时间
8GET/POSTApp.Post.Create发布信息 发布招聘/商铺/二手等信息
9GET/POSTApp.Post.Update更新信息 更新已发布的信息
10GET/POSTApp.Post.SetTop置顶信息 设置信息置顶
11GET/POSTApp.Post.GetPublishConfig获取发布配置 获取发布时长选项、会员权益等配置
12GET/POSTApp.Common.Report举报信息 举报违规信息
13GET/POSTApp.Common.GetAttrConfig获取类型扩展属性配置 获取各类型的扩展属性字段配置,用于动态表单
14GET/POSTApp.Common.GetConfig获取系统配置 获取小程序基础配置
15GET/POSTApp.Common.GetHomeData获取首页数据 获取首页展示数据,包括分类和推荐信息
16GET/POSTApp.Category.GetList获取分类列表 获取指定类型或父级下的分类
17GET/POSTApp.Category.GetTree获取分类树 获取分类树形结构
18GET/POSTApp.Category.GetAll获取所有顶级分类 获取首页展示的所有顶级分类
19GET/POSTApp.Distribution.ApplyWithdraw申请提现//请使用@desc 注释
20GET/POSTApp.Distribution.BindInvite绑定邀请关系//请使用@desc 注释
21GET/POSTApp.Distribution.GetCommissionList获取佣金列表//请使用@desc 注释
22GET/POSTApp.Distribution.GetInfo获取分销信息//请使用@desc 注释
23GET/POSTApp.Distribution.GetTeamList获取团队列表//请使用@desc 注释
24GET/POSTApp.Distribution.GetWithdrawList获取提现列表//请使用@desc 注释
25GET/POSTApp.Examples_QrCode.Png二维码 - 根据文本内容,生成二维码 可根据传入的文本内容,生成对应的二维码,还可以调整尺寸大小。可以直接输出png图片,也可以返回base64后的图片数据。
26GET/POSTApp.Examples_DataApi.CreateData创建新数据 通用数据接口,创建一条新数据
27GET/POSTApp.Examples_Rule.JsonArray参数示例 - JSON数组参数 演示如何配置JSON格式的数组参数,并原路返回。
28GET/POSTApp.Examples_Rule.ExplodeArray参数示例 - 分割的数组参数 以英文逗号分割的数组,并且可以设置数组个数。
29GET/POSTApp.Examples_Rule.Str参数示例 - 字符串参数 简单的字符串参数
30GET/POSTApp.Examples_Rule.TrueOrFalse参数示例 - 开关参数 true或false的开关参数。
31GET/POSTApp.Examples_Rule.RangeNumber参数示例 - 指定范围的整数参数 指定范围的整数参数,可以设置最小值、最大值,当设定默认值时,对客户端则不是必传参数。
32GET/POSTApp.Examples_Rule.Number参数示例 - 整数参数 必须的整数参数
33GET/POSTApp.Examples_Rule.DateStr参数示例 - 日期参数 字符串的日期参数,例如格式:Y-m-d H:i:s
34GET/POSTApp.Examples_Rule.DateTimestamp参数示例 - 时间戳日期参数 时间戳日期参数,输入日期字符串参数,如传:2019-03-01 00:00:00,接口接收后会转成:1551369600。
35GET/POSTApp.Examples_Rule.SexEnum参数示例 - 枚举参数 例如,男或女的性别参数。
36GET/POSTApp.Examples_Rule.RegexStr参数示例 - 正则字符串参数 指定正则的字符串参数
37GET/POSTApp.Examples_Rule.VersionCallback参数示例 - 版本回调参数 回调类型的参数,可以自定义参数的检测、转换和校验逻辑。例如版本号。
38GET/POSTApp.Examples_Rule.StatusEnum参数示例 - 状态枚举参数 对于是数值的枚举范围,注意配置时请用字符串类型。
39GET/POSTApp.Examples_Rule.DefaultStr参数示例 - 默认且必须的字符串参数 带默认值,并且为必须的字符串参数。默认是string类型,所以一般不用配置type为string。
40GET/POSTApp.Examples_Response.Debug展示调试相关能力 使用前请开启调试模式,效果更佳
41GET/POSTApp.Examples_DataApi.DeleteDataIDs批量删除 通用数据接口,根据ID批量删除数据
42GET/POSTApp.Examples_CURD.Delete数据库示例 - 删除数据 根据ID删除数据库中的一条纪录数据
43GET/POSTApp.Examples_CURD.Insert数据库示例 - 插入数据 向数据库插入一条纪录数据
44POSTApp.Examples_CURD.Update数据库示例 - 更新数据 根据ID更新数据库中的一条纪录数据
45GET/POSTApp.Examples_CURD.SqlDebug数据库示例 - 演示如何进行SQL调试和相关的使用 除此接口外,其他示例也可进行在线调试。本示例将便详细说明如何调试。
46GET/POSTApp.Examples_CURD.GetList数据库示例 - 获取分页列表数据 根据状态筛选列表数据,支持分页
47GETApp.Examples_CURD.Get数据库示例 - 获取数据 根据ID获取数据库中的一条纪录数据
48POSTApp.Examples_Upload.Go文件上传 - 图片文件上传 只能上传单个图片文件
49GETApp.Examples_Docs.Usage文档示例 - 接口文档使用示例 接口说明,更多使用请参考官方文档http://docs.phalapi.net/#/v2.0/api-docs
50GET/POSTApp.Examples_Log.Run日记 - 写入日志 演示日志操作,包括写系统异常类日志、业务纪录类日志、开发调试类日志
51GET/POSTApp.Examples_DataApi.UpdateData更新数据 通用数据接口,根据ID更新单条数据
52GET/POSTApp.Examples_DataApi.DeleteData根据ID删除数据 根据单个ID删除数据,也可以调整成根据自定义的条件删除数据
53GET/POSTApp.Examples_Response.TopResult演示在返回结果根节点添加额外的字段返回 自定义动态返回JSON根节点,增加最外层返回消息,例如最外层的【status 状态码】和【time 当前系统时间】
54GET/POSTApp.Examples_DataApi.GetData获取一条数据 通用数据接口,根据ID获取一条数据
55GET/POSTApp.Examples_DataApi.TableList获取表格列表数据 通用数据接口,获取表格列表数据,默认按ID降序返回,支持分页和搜索
56GET/POSTApp.Favorite.Remove取消收藏 取消收藏一条信息
57GET/POSTApp.Favorite.List收藏列表 获取我的收藏列表
58GET/POSTApp.Favorite.Check检查是否已收藏 检查某条信息是否已收藏
59GET/POSTApp.Favorite.Add添加收藏 收藏一条信息
60GET/POSTApp.User.Login微信登录 通过微信code换取用户信息并登录
61GET/POSTApp.User.MyPosts我的发布 获取当前用户发布的信息列表
62GET/POSTApp.User.UpdateInfo更新用户信息 更新昵称、头像、手机号等
63GET/POSTApp.User.TestLogin测试登录(开发用) 通过手机号直接登录,用于开发测试
64GET/POSTApp.User.GetMemberInfo获取会员信息 获取当前用户的会员权益信息
65GET/POSTApp.User.GetMemberPlans获取会员套餐列表 获取所有可用的会员套餐
66GET/POSTApp.User.GetInfo获取用户信息 获取当前登录用户信息
67GET/POSTApp.User.BuyMember购买会员 购买会员套餐
68GET/POSTApp.AdminReport.List举报列表//请使用@desc 注释
69GET/POSTApp.AdminReport.Handle处理举报//请使用@desc 注释
70GET/POSTApp.AdminMemberPlan.Create//请检测函数注释//请使用@desc 注释
71GET/POSTApp.AdminMemberPlan.Delete//请检测函数注释//请使用@desc 注释
72GET/POSTApp.AdminMemberPlan.Detail//请检测函数注释//请使用@desc 注释
73GET/POSTApp.AdminMemberPlan.List//请检测函数注释//请使用@desc 注释
74GET/POSTApp.AdminMemberPlan.Update//请检测函数注释//请使用@desc 注释
75GET/POSTApp.AdminPost.List信息列表//请使用@desc 注释
76GET/POSTApp.AdminPost.Detail信息详情//请使用@desc 注释
77GET/POSTApp.AdminPost.Delete删除信息//请使用@desc 注释
78GET/POSTApp.AdminPost.Create发布信息 后台发布信息,直接通过审核
79GET/POSTApp.AdminPost.Audit审核信息//请使用@desc 注释
80GET/POSTApp.AdminPost.BatchDelete批量删除//请使用@desc 注释
81GET/POSTApp.AdminPost.BatchAudit批量审核//请使用@desc 注释
82GET/POSTApp.AdminPost.Update编辑信息//请使用@desc 注释
83GET/POSTApp.AdminPost.SetTop设置置顶//请使用@desc 注释
84GET/POSTApp.AdminCategory.List分类列表//请使用@desc 注释
85GET/POSTApp.AdminCategory.Tree分类树//请使用@desc 注释
86GET/POSTApp.AdminCategory.Create创建分类//请使用@desc 注释
87GET/POSTApp.AdminCategory.Delete删除分类//请使用@desc 注释
88GET/POSTApp.AdminCategory.Update更新分类//请使用@desc 注释
89GET/POSTApp.AdminUser.Update更新用户信息 修改用户会员套餐等信息
90GET/POSTApp.AdminUser.List用户列表//请使用@desc 注释
91GET/POSTApp.AdminUser.Detail用户详情//请使用@desc 注释
92GET/POSTApp.AdminUser.SetStatus设置用户状态 禁用/启用用户
93GET/POSTApp.Admin.UpdatePassword修改密码//请使用@desc 注释
94GET/POSTApp.Admin.Create创建管理员 仅超级管理员可用
95GET/POSTApp.Admin.Delete删除管理员 仅超级管理员可用
96GET/POSTApp.Admin.Update更新管理员 仅超级管理员可用
97GET/POSTApp.Admin.List管理员列表 仅超级管理员可用
98GET/POSTApp.Admin.Login管理员登录 管理员账号密码登录
99GET/POSTApp.Admin.GetDashboard获取仪表盘数据//请使用@desc 注释
100GET/POSTApp.Admin.GetInfo获取当前管理员信息//请使用@desc 注释
101GET/POSTApp.Admin.Logout退出登录//请使用@desc 注释
102GET/POSTApp.AdminConfig.SaveWechatMp保存公众号配置//请使用@desc 注释
103GET/POSTApp.AdminConfig.SaveMiniapp保存小程序配置//请使用@desc 注释
104GET/POSTApp.AdminConfig.SavePayment保存支付配置//请使用@desc 注释
105GET/POSTApp.AdminConfig.Save保存配置//请使用@desc 注释
106GET/POSTApp.AdminConfig.GetWechatMp获取公众号配置//请使用@desc 注释
107GET/POSTApp.AdminConfig.GetMiniapp获取小程序配置//请使用@desc 注释
108GET/POSTApp.AdminConfig.GetAll获取所有配置 获取所有系统配置(按分组)
109GET/POSTApp.AdminConfig.GetGroup获取指定分组配置//请使用@desc 注释
110GET/POSTApp.AdminConfig.GetPayment获取支付配置//请使用@desc 注释
切换到折叠版
温馨提示: 此接口文档根据接口代码和注释实时自动生成,可在接口类的文件注释的第一行修改左侧菜单标题。
PhalApi

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