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

#	请求方式	接口服务	接口名称	接口描述
1	GET/POST	App.Hello.World	示例接口	//请使用@desc 注释
2	POST	App.SiteCollection_Upload.UploadFile	上传文件	上传附件文件，支持图片、文档等多种类型
3	POST	App.SiteCollection_Upload.DeleteAttachment	删除附件	删除指定的附件（包括物理文件和数据库记录）
4	GET	App.SiteCollection_Upload.GetAttachmentList	获取附件列表	获取指定资料收集项目的附件列表
5	POST	App.SiteCollection_Collection.SaveProduct	保存产品资料信息（步骤4）	保存或更新产品资料相关信息
6	POST	App.SiteCollection_Collection.SaveCompany	保存公司资料信息（步骤3）	保存或更新公司资料相关信息
7	POST	App.SiteCollection_Collection.SaveOtherPage	保存其他页面资料信息（步骤6）	保存或更新其他页面资料，包括FAQ附件、资料下载附件、自定义页面列表
8	POST	App.SiteCollection_Collection.SaveNews	保存新闻资料信息（步骤5）	保存或更新新闻资料相关信息
9	POST	App.SiteCollection_Collection.SaveOptimization	保存网站优化信息（步骤8）	保存或更新网站优化相关信息
10	POST	App.SiteCollection_Collection.SaveStyle	保存网站风格信息（步骤1）	保存或更新网站风格相关信息
11	POST	App.SiteCollection_Collection.SaveContact	保存联系资料信息（步骤7）	保存或更新联系资料，支持灵活的联系方式字段
12	POST	App.SiteCollection_Collection.SaveHomepage	保存首页内容信息（步骤2）	保存或更新首页内容相关信息，包括导航、Banner、其他内容等
13	POST	App.SiteCollection_Collection.Delete	删除资料收集项目	删除资料收集项目及其所有相关数据
14	POST	App.SiteCollection_Collection.SubmitForReview	提交审核	提交资料收集项目进行审核
15	POST	App.SiteCollection_Collection.Update	更新资料收集项目	更新资料收集项目的基本信息
16	GET	App.SiteCollection_Collection.CheckCustomer	检查客户名称是否存在	检查指定客户名称是否已存在进行中的资料收集项目
17	POST	App.SiteCollection_Collection.GetOrCreate	获取或创建资料收集项目	如果客户名称已存在进行中的项目则返回该项目，否则创建新项目
18	GET	App.SiteCollection_Collection.GetList	获取资料收集列表	获取资料收集项目列表，支持分页和筛选
19	GET	App.SiteCollection_Collection.GetDetail	获取资料收集详情	获取资料收集项目的完整详情，包含所有步骤的数据
20	GET/POST	App.Examples_QrCode.Png	二维码 - 根据文本内容，生成二维码	可根据传入的文本内容，生成对应的二维码，还可以调整尺寸大小。可以直接输出png图片，也可以返回base64后的图片数据。
21	GET/POST	App.Examples_DataApi.CreateData	创建新数据	通用数据接口，创建一条新数据
22	GET/POST	App.Examples_Rule.JsonArray	参数示例 - JSON数组参数	演示如何配置JSON格式的数组参数，并原路返回。
23	GET/POST	App.Examples_Rule.ExplodeArray	参数示例 - 分割的数组参数	以英文逗号分割的数组，并且可以设置数组个数。
24	GET/POST	App.Examples_Rule.Str	参数示例 - 字符串参数	简单的字符串参数
25	GET/POST	App.Examples_Rule.TrueOrFalse	参数示例 - 开关参数	true或false的开关参数。
26	GET/POST	App.Examples_Rule.RangeNumber	参数示例 - 指定范围的整数参数	指定范围的整数参数，可以设置最小值、最大值，当设定默认值时，对客户端则不是必传参数。
27	GET/POST	App.Examples_Rule.Number	参数示例 - 整数参数	必须的整数参数
28	GET/POST	App.Examples_Rule.DateStr	参数示例 - 日期参数	字符串的日期参数，例如格式：Y-m-d H:i:s
29	GET/POST	App.Examples_Rule.DateTimestamp	参数示例 - 时间戳日期参数	时间戳日期参数，输入日期字符串参数，如传：2019-03-01 00:00:00，接口接收后会转成：1551369600。
30	GET/POST	App.Examples_Rule.SexEnum	参数示例 - 枚举参数	例如，男或女的性别参数。
31	GET/POST	App.Examples_Rule.RegexStr	参数示例 - 正则字符串参数	指定正则的字符串参数
32	GET/POST	App.Examples_Rule.VersionCallback	参数示例 - 版本回调参数	回调类型的参数，可以自定义参数的检测、转换和校验逻辑。例如版本号。
33	GET/POST	App.Examples_Rule.StatusEnum	参数示例 - 状态枚举参数	对于是数值的枚举范围，注意配置时请用字符串类型。
34	GET/POST	App.Examples_Rule.DefaultStr	参数示例 - 默认且必须的字符串参数	带默认值，并且为必须的字符串参数。默认是string类型，所以一般不用配置type为string。
35	GET/POST	App.Examples_Response.Debug	展示调试相关能力	使用前请开启调试模式，效果更佳
36	GET/POST	App.Examples_DataApi.DeleteDataIDs	批量删除	通用数据接口，根据ID批量删除数据
37	GET/POST	App.Examples_CURD.Delete	数据库示例 - 删除数据	根据ID删除数据库中的一条纪录数据
38	GET/POST	App.Examples_CURD.Insert	数据库示例 - 插入数据	向数据库插入一条纪录数据
39	POST	App.Examples_CURD.Update	数据库示例 - 更新数据	根据ID更新数据库中的一条纪录数据
40	GET/POST	App.Examples_CURD.SqlDebug	数据库示例 - 演示如何进行SQL调试和相关的使用	除此接口外，其他示例也可进行在线调试。本示例将便详细说明如何调试。
41	GET/POST	App.Examples_CURD.GetList	数据库示例 - 获取分页列表数据	根据状态筛选列表数据，支持分页
42	GET	App.Examples_CURD.Get	数据库示例 - 获取数据	根据ID获取数据库中的一条纪录数据
43	POST	App.Examples_Upload.Go	文件上传 - 图片文件上传	只能上传单个图片文件
44	GET	App.Examples_Docs.Usage	文档示例 - 接口文档使用示例	接口说明，更多使用请参考官方文档http://docs.phalapi.net/#/v2.0/api-docs
45	GET/POST	App.Examples_Log.Run	日记 - 写入日志	演示日志操作，包括写系统异常类日志、业务纪录类日志、开发调试类日志
46	GET/POST	App.Examples_DataApi.UpdateData	更新数据	通用数据接口，根据ID更新单条数据
47	GET/POST	App.Examples_DataApi.DeleteData	根据ID删除数据	根据单个ID删除数据，也可以调整成根据自定义的条件删除数据
48	GET/POST	App.Examples_Response.TopResult	演示在返回结果根节点添加额外的字段返回	自定义动态返回JSON根节点，增加最外层返回消息，例如最外层的【status 状态码】和【time 当前系统时间】
49	GET/POST	App.Examples_DataApi.GetData	获取一条数据	通用数据接口，根据ID获取一条数据
50	GET/POST	App.Examples_DataApi.TableList	获取表格列表数据	通用数据接口，获取表格列表数据，默认按ID降序返回，支持分页和搜索

切换到折叠版

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