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

首页接口文档开发文档

#	请求方式	接口服务	接口名称	接口描述
1	GET/POST	App.Hello.World	示例接口	//请使用@desc 注释
2	GET/POST	App.Examples_QrCode.Png	二维码 - 根据文本内容，生成二维码	可根据传入的文本内容，生成对应的二维码，还可以调整尺寸大小。可以直接输出png图片，也可以返回base64后的图片数据。
3	GET/POST	App.Examples_DataApi.CreateData	创建新数据	通用数据接口，创建一条新数据
4	GET/POST	App.Examples_Rule.JsonArray	参数示例 - JSON数组参数	演示如何配置JSON格式的数组参数，并原路返回。
5	GET/POST	App.Examples_Rule.ExplodeArray	参数示例 - 分割的数组参数	以英文逗号分割的数组，并且可以设置数组个数。
6	GET/POST	App.Examples_Rule.Str	参数示例 - 字符串参数	简单的字符串参数
7	GET/POST	App.Examples_Rule.TrueOrFalse	参数示例 - 开关参数	true或false的开关参数。
8	GET/POST	App.Examples_Rule.RangeNumber	参数示例 - 指定范围的整数参数	指定范围的整数参数，可以设置最小值、最大值，当设定默认值时，对客户端则不是必传参数。
9	GET/POST	App.Examples_Rule.Number	参数示例 - 整数参数	必须的整数参数
10	GET/POST	App.Examples_Rule.DateStr	参数示例 - 日期参数	字符串的日期参数，例如格式：Y-m-d H:i:s
11	GET/POST	App.Examples_Rule.DateTimestamp	参数示例 - 时间戳日期参数	时间戳日期参数，输入日期字符串参数，如传：2019-03-01 00:00:00，接口接收后会转成：1551369600。
12	GET/POST	App.Examples_Rule.SexEnum	参数示例 - 枚举参数	例如，男或女的性别参数。
13	GET/POST	App.Examples_Rule.RegexStr	参数示例 - 正则字符串参数	指定正则的字符串参数
14	GET/POST	App.Examples_Rule.VersionCallback	参数示例 - 版本回调参数	回调类型的参数，可以自定义参数的检测、转换和校验逻辑。例如版本号。
15	GET/POST	App.Examples_Rule.StatusEnum	参数示例 - 状态枚举参数	对于是数值的枚举范围，注意配置时请用字符串类型。
16	GET/POST	App.Examples_Rule.DefaultStr	参数示例 - 默认且必须的字符串参数	带默认值，并且为必须的字符串参数。默认是string类型，所以一般不用配置type为string。
17	GET/POST	App.Examples_Response.Debug	展示调试相关能力	使用前请开启调试模式，效果更佳
18	GET/POST	App.Examples_DataApi.DeleteDataIDs	批量删除	通用数据接口，根据ID批量删除数据
19	GET/POST	App.Examples_CURD.Delete	数据库示例 - 删除数据	根据ID删除数据库中的一条纪录数据
20	GET/POST	App.Examples_CURD.Insert	数据库示例 - 插入数据	向数据库插入一条纪录数据
21	POST	App.Examples_CURD.Update	数据库示例 - 更新数据	根据ID更新数据库中的一条纪录数据
22	GET/POST	App.Examples_CURD.SqlDebug	数据库示例 - 演示如何进行SQL调试和相关的使用	除此接口外，其他示例也可进行在线调试。本示例将便详细说明如何调试。
23	GET/POST	App.Examples_CURD.GetList	数据库示例 - 获取分页列表数据	根据状态筛选列表数据，支持分页
24	GET	App.Examples_CURD.Get	数据库示例 - 获取数据	根据ID获取数据库中的一条纪录数据
25	POST	App.Examples_Upload.Go	文件上传 - 图片文件上传	只能上传单个图片文件
26	GET	App.Examples_Docs.Usage	文档示例 - 接口文档使用示例	接口说明，更多使用请参考官方文档http://docs.phalapi.net/#/v2.0/api-docs
27	GET/POST	App.Examples_Log.Run	日记 - 写入日志	演示日志操作，包括写系统异常类日志、业务纪录类日志、开发调试类日志
28	GET/POST	App.Examples_DataApi.UpdateData	更新数据	通用数据接口，根据ID更新单条数据
29	GET/POST	App.Examples_DataApi.DeleteData	根据ID删除数据	根据单个ID删除数据，也可以调整成根据自定义的条件删除数据
30	GET/POST	App.Examples_Response.TopResult	演示在返回结果根节点添加额外的字段返回	自定义动态返回JSON根节点，增加最外层返回消息，例如最外层的【status 状态码】和【time 当前系统时间】
31	GET/POST	App.Examples_DataApi.GetData	获取一条数据	通用数据接口，根据ID获取一条数据
32	GET/POST	App.Examples_DataApi.TableList	获取表格列表数据	通用数据接口，获取表格列表数据，默认按ID降序返回，支持分页和搜索

切换到折叠版

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