在线接口文档管理工具（小幺鸡）使用说明

女爷i 2022-06-11 00:24 586阅读 0赞

# 在线接口文档管理工具（小幺鸡）使用说明 #

### 前言 ###

小幺鸡的地址：[http://www.xiaoyaoji.cn/][http_www.xiaoyaoji.cn]

几大看点：

在线接口测试；  
可视化编辑与分享；  
代码开源。可以离线部署。  
下面简单介绍下怎么离线安装与使用。

### 1.下载与安装 ###

代码在：[http://git.oschina.net/zhoujingjie/apiManager][http_git.oschina.net_zhoujingjie_apiManager]

1.  从[http://git.oschina.net/zhoujingjie/apiManager/releases][http_git.oschina.net_zhoujingjie_apiManager_releases]下载最新版本。
2.  解压到tomcat\_home/webapps/ROOT目录下
3.  新建MYSQL数据库-编码格式utf8mb4格式，INNODB引擎。
4.  导入sql - SQL文件在doc目录下
5.  修改tomcat\_home/webapps/ROOT/WEB-INF/classes/config.properties 的数据库与其他信息
6.  启动tomcat，使用chrome浏览器访问[http://localhost:8080][http_localhost_8080]

### 2.基本使用 ###

在tomcat中运行起来后，点击首页中的“立即使用”按钮。  
![这里写图片描述][2ee20003ef2754fa0d67]

这个时候会跳转到登陆页面，没有账号就点一下“免费注册”注册一个账号，然后登陆。  
登陆进去后，首先创建一个项目。  
![这里写图片描述][2ee500027a279b1bddca]  
默认有一个文档，我们点击重命名改成文档说明。  
![这里写图片描述][2ee10004a377b3563c66]

这个就是接口文档的一个简要介绍。示例：  
![这里写图片描述][2ed80003f035e051a1a0]

假如现在要添加一个用户登录的接口，那第一步先创建一个文件夹（用户信息接口）  
![这里写图片描述][2ee20003f0fa3dec87db]  
然后在这个文件夹下面创建一个http接口：  
![这里写图片描述][2ee500027bd317036799]  
示例：  
![这里写图片描述][2ed80003f598770a2774]  
然后点一下右上角的保存，然后点预览文档看下效果：  
![这里写图片描述][2edb0003fb63098d89e3]

在下面填入相关参数，点“立即运行”就可以调试接口了。

### 3.多环境支持 ###

不同的环境，接口的地址不同。我们可以在全局设置中添加环境变量。 进入某个项目后，点击上面的“编辑文档”，然后点“全局设置”，然后点“环境变量”。

比如这里配置了2个不同的host和port  
![这里写图片描述][2ee10004a7be1b50a6ab]  
在接口地址中，使用变量名就可以了。 比如：  
![这里写图片描述][2ee40003f58c675c7874]  
在演示的地方，可以切换不同的环境：  
![这里写图片描述][2ee500027efba93fb6da]

问题：

提示跨域错误 解决参考：[http://www.xiaoyaoji.cn/help.html][http_www.xiaoyaoji.cn_help.html]  
注：这里的版本为xiaoyaoji-2.0.1.

[http_www.xiaoyaoji.cn]: http://www.xiaoyaoji.cn/
[http_git.oschina.net_zhoujingjie_apiManager]: http://git.oschina.net/zhoujingjie/apiManager
[http_git.oschina.net_zhoujingjie_apiManager_releases]: http://git.oschina.net/zhoujingjie/apiManager/releases
[http_localhost_8080]: http://localhost:8080
[2ee20003ef2754fa0d67]: http://p3.pstatp.com/large/2ee20003ef2754fa0d67
[2ee500027a279b1bddca]: http://p3.pstatp.com/large/2ee500027a279b1bddca
[2ee10004a377b3563c66]: http://p9.pstatp.com/large/2ee10004a377b3563c66
[2ed80003f035e051a1a0]: /images/20220611/f83c1d7f9a8d44cdbdf52495250d5a82.png
[2ee20003f0fa3dec87db]: /images/20220611/430a947afd4945678c39a3eac5377f31.png
[2ee500027bd317036799]: http://p9.pstatp.com/large/2ee500027bd317036799
[2ed80003f598770a2774]: http://p3.pstatp.com/large/2ed80003f598770a2774
[2edb0003fb63098d89e3]: http://p3.pstatp.com/large/2edb0003fb63098d89e3
[2ee10004a7be1b50a6ab]: http://p9.pstatp.com/large/2ee10004a7be1b50a6ab
[2ee40003f58c675c7874]: http://p3.pstatp.com/large/2ee40003f58c675c7874
[2ee500027efba93fb6da]: http://p3.pstatp.com/large/2ee500027efba93fb6da
[http_www.xiaoyaoji.cn_help.html]: http://www.xiaoyaoji.cn/help.html