# API接口系统使用手册

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

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

## 访问在线接口文档

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

![](http://cdn7.okayapi.com/yesyesapi_20200427160815_c85671982f124e2f1f3d0121c5814c2a.png)  

如果管理员有设置密码，则需要输入文档查看密码方能查看接口。  
![](http://cdn7.okayapi.com/yesyesapi_20200427160924_fa59bde39f981865be131f9afebbce66.png)  

## 在线接口文档列表

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

为了避免内部接口暴露，游客只能看到开放部分的API接口。如下：  
![](http://cdn7.okayapi.com/yesyesapi_20200427161122_0b28479cac22774f0c76b66aae78a172.png)  

管理员登录管理后台后，可以查看全部的API接口，包括内部接口。如下：  
![](http://cdn7.okayapi.com/yesyesapi_20200427161233_f782160101163ad104d552f36334c0b4.png)  

## 接口文档详情页

点击进入，可查看接口文档详情页。如下：  
![](http://cdn7.okayapi.com/yesyesapi_20200427161343_f060c62e7ee38b94a79589c86b67a8eb.png)  

填写接口参数后，可以进行在线接口测试：  
![](http://cdn7.okayapi.com/yesyesapi_20200427161449_bec5ade952c33b600a13fdc030754305.png)  


## 展开查看全部接口
点击【切换到展开版】，可以查看全部的接口。  
![](http://cdn7.okayapi.com/yesyesapi_20200427161603_a441f5e56bc7656e67e5da32c6b632b6.png)  

## 搜索接口

可以进行接口的搜索，模糊匹配接口名称和接口描述，以及接口英文名称。  
![](http://cdn7.okayapi.com/yesyesapi_20200427161701_2e4a5c4e0813ab3fada6c617915d9838.png)

## 英文版
你可以切换语言到英文版，也可以添加其他翻译语言。  
![](http://cdn7.okayapi.com/yesyesapi_20200427161802_b1d1d306ecfedb7cfba73c3fc01f663c.png)

