66 lines
2.4 KiB
Markdown
66 lines
2.4 KiB
Markdown
# 在线接口文档
|
||
|
||
## 访问接口文档
|
||
|
||
部署和安装好PhalApi专业版后，便可以通过浏览器访问：```http://你的域名/docs.php```，查看在线接口文档。
|
||
|
||
例如：http://open.phalapi.net/docs.php
|
||
|
||
看到的在线接口文档效果类似如下：
|
||
|
||
|
||
|
||
|
||
## 如何编写接口文档
|
||
|
||
请参考[接口文档 - PhalApi 2.x 开发文档](http://docs.phalapi.net/#/v2.0/api-docs)。
|
||
|
||
## 如何查看全部接口
|
||
默认情况下隐藏了内部接口（Platform开放平台接口、Admin管理后台接口和Task计划任务接口），登录管理后台后，方可查看全部接口。避免被外部开发者看到敏感的接口。
|
||
|
||
非管理员只能看到App开放接口。
|
||
|
||
|
||
管理员登录后可查看全部接口。
|
||
|
||
|
||
但无论是否为管理员登录，都可以通过完整的在线接口文档详情页链接直接访问相应的接口文档。
|
||
|
||
## 如何设置文档查看密码
|
||
|
||
默认情况下，查看在线接口文档不需要输入密码。若为了保护接口文档不被外界访问，可以设置文档查看密码。
|
||
|
||
打开```./config/app.php```配置文件，找到```doc_view_code```，然后把此配置修改为所需要的查看密码，例如：123456。
|
||
```php
|
||
// 查看文档的密码，为空时不需要密码
|
||
'doc_view_code' => '123456',
|
||
```
|
||
|
||
重新打开接口文档，会提示输入查看密码。
|
||
|
||
例如：
|
||
|
||
|
||
如果输入的密码错误，将会提示相应的错误。
|
||
|
||
|
||
如果查看密码正确，将直接进入相应的接口文档页面。
|
||
|
||
|
||
## 如何生成离线接口文档
|
||
|
||
在根目录，执行以下脚本命令，可生成离线接口文档。
|
||
|
||
```
|
||
$ php ./public/docs.php
|
||
|
||
脚本执行完毕！离线文档保存路径为：
|
||
/path/to/phalapi-pro/public/docs
|
||
```
|
||
|
||
生成离线文档后，可以在目录里看到类似以下的HTML文档：
|
||
|
||
|
||
用浏览器打开public/docs/index.html首页，便可查看离线版的接口文档。
|
||
|