Files
phalapi-pro/public/wiki/api.md
2022-03-21 11:16:38 +08:00

2.0 KiB
Raw Blame History

API接口系统使用手册

API接口是最为重要的服务是可以提供给客户端应用、第三方系统以及内部项目使用的接口。

这里简单介绍下如何查看和使用在线接口文档。

访问在线接口文档

安装好后,进入首页,通过点击顶部的【开放接口】,可以访问接口文档。

如果管理员有设置密码,则需要输入文档查看密码方能查看接口。

在线接口文档列表

在线接口文档列表会根据PHP接口代码自动生成无须人工编辑和维护。

为了避免内部接口暴露游客只能看到开放部分的API接口。如下

管理员登录管理后台后可以查看全部的API接口包括内部接口。如下

接口文档详情页

点击进入,可查看接口文档详情页。如下:

填写接口参数后,可以进行在线接口测试:

展开查看全部接口

点击【切换到展开版】,可以查看全部的接口。

搜索接口

可以进行接口的搜索,模糊匹配接口名称和接口描述,以及接口英文名称。

英文版

你可以切换语言到英文版,也可以添加其他翻译语言。