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

小幺鸡的地址:http://www.xiaoyaoji.cn/

几大看点:

  1. 在线接口测试;
  2. 可视化编辑与分享;
  3. 代码开源。可以离线部署。

下面简单介绍下怎么离线安装与使用。

1.下载与安装

代码在:http://git.oschina.net/zhoujingjie/apiManager

  1. 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

2.基本使用

在tomcat中运行起来后,点击首页中的“立即使用”按钮。

这个时候会跳转到登陆页面,没有账号就点一下“免费注册”注册一个账号,然后登陆。

登陆进去后,首先创建一个项目。

默认有一个文档,我们点击重命名
改成文档说明。

这个就是接口文档的一个简要介绍。示例:

假如现在要添加一个用户登录的接口,那第一步先创建一个文件夹(用户信息接口)

然后在这个文件夹下面创建一个http接口:

示例:

然后点一下右上角的保存,然后点预览文档看下效果:


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

3.多环境支持

不同的环境,接口的地址不同。我们可以在全局设置中添加环境变量。
进入某个项目后,点击上面的“编辑文档”,然后点“全局设置”,然后点“环境变量”。
比如这里配置了2个不同的host和port

在接口地址中,使用$变量名$就可以了。
比如:

在演示的地方,可以切换不同的环境:

问题:

  1. 提示跨域错误
    解决参考:http://www.xiaoyaoji.cn/help.html

注:这里的版本为xiaoyaoji-2.0.1.

Donny wechat
欢迎关注我的个人公众号
打赏,是超越赞的一种表达。
Show comments from Gitment