RAP接口管理工具

RAP是阿里开源的接口管理工具，主要包括开发团队/项目的管理，编写API接口，MOCK服务，接口测试，生成接口文档等功能。并且RAP是可以在本地环境中进行部署使用的（linux，windows皆可），这里也建议本地部署，第一不受网络限制，第二数据放在自己的数据库中便于后续的功能扩展或分析。

关于RAP的部署，网络上有较多的教程，这里就不再重复，主要需要java1.8，mysql5.6（mysql5.5导入sql会报错），tomcat8+，redis3.0+，RAP-0.14.16-SNAPSHOT.war。下面就RAP的一些基本使用简单介绍（介绍来自于对视频教程的学习结合实际的开发实践）：

一、创建团队，产品线、项目等

RAP的一个好处是提供了团队/成员管理和产品/项目管理，有利于多项目协作，接口共享，创建团队截图如下：

二、版本管理

RAP对于接口文档的编辑提供了版本管理功能（吐槽下：保存一次就是一个新版本，版本太多根本看不过来……）。

三、添加接口

RAP的另一个好处是接口采用界面的方式进行管理，有利于对接口更好的分类，截图如下：

四、根据文档生成模拟数据

RAP是根据接口文档中接口的数据类型生成相关的模拟数据，截图如下：

五、MOCK服务

估计大家已经注意到上图中备注里的mock函数，mock服务采用mockjs，历史图片中${请求参数名}代表接口请求参数的值，可以使用这个值模拟生成与请求参数相关的值，例如：

@mock=仓鼠${userId=不知名}号

根据输入的userId生成一个userName，其中userId=xx表示采用默认值，即不输入userId的情况下默认使用不知名，同时，对于复杂的关系，也可以使用function()函数生成。

六、导入json自动生成接口格式

在开发工作中，经常会遇到后台接口已经写好再补写文档的情况，或者接口是echarts的图表需要的json数据（这时候可以直接去echarts示例copy下来json数据生成接口，无需后台参与），这个时候RAP的json导入就比较实用，可以直接将json数据导入成API接口。例如：

{
    "user": {
        "userName": "仓鼠1号", 
        "userSex": "男", 
        "userAge": 16
    }, 
    "action": [
        {
            "name": "跑图", 
            "time": "2018-06-02 12:00:00", 
            "result": "失败"
        }, 
        {
            "name": "寻宝", 
            "time": "2018-06-02 12:10:00", 
            "result": "好像没找到啥"
        }
    ], 
    "nextPage": 1
}

这里笔者通过后台接口生成了一个比较复杂的json，通过RAP的json导入工具，可以直接导入API格式，导入变量的同时，还会使用@mock保存导入的数据：

七、前端代码使用接口模拟数据

使用RAP写好代码后，可以直接通过其后台提供的js工具调用模拟数据，无需后台参与。首先在配置里找到js路径：

复制到前端代码中：

<block name="script">
    <script src="http://192.168.60.85:8080/rap.plugin.js?projectId=2&mode=0"></script>
    <script type="text/javascript">
        $(function(){
            $.ajax({
                url:"useMockFun",
                //url:"{:U('Text/ajaxOutData')}",
                //url:"3ma/index.php?s=/Home/Text/ajaxOutData",
                type:"POST",
                data:{
                    userId:1,
                    nowPage:1
                },
                success:function(res){
                    console.log(res);
                }

            });
        });

    </script>
</block>

这里useMockFun就是RAP对应接口的请求url，这里直接ajax请求RAP并打印了相关结果，无需后台参与，phper应该已经发现，这里是将RAP的js工具整合到了thinkphp中使用。当需要与后台正式对接时，即注释掉<script src="http://192.168.60.85:8080/rap.plugin.js?projectId=2&mode=0"></script>这句，并将url改为实际的url即可。

八、接口测试

RAP带有接口测试功能，用于测试返回数据的格式和类型是否是API接口文档相同，<script src="http://192.168.60.85:8080/rap.plugin.js?projectId=2&mode=0"></script>，只需要添加mode=0，但是前提要保证RAP文档的请求url与实际的url一致，由于thinkphp中url生成使用的U函数，故这里需要把U函数结果url作为RAP的请求url，即url:"3ma/index.php?s=/Home/Text/ajaxOutData",测试结果如下：

九、导出文档

RAP可以将线上编写的API文档出成html（默认的虽说是稍微丑了点，不过可以通过修改css进行美化）