不会看接口文档怎么办?

有接口文档,但是我看不懂,不知道从何下手怎么办啊,谁 能 给我讲讲流程啊

img

img


是不是我先写个按钮,然后写function点击事件,然后再写个接口去调用前台传的数据啊
第一次看接口文档,不知道啥是啥,求 教教我流程是啥

img

img


最常用的前后端交互大都利用ajax,原生ajax,JQ封装的ajax,用vue的话就用axio,这里用jq以你给的仪表号同步api为例


$.ajax({
            "url" : "http:ip:端口/portal/pulishes/json/upMeter",    //接口地址
            "data" : {        //规定要发送到服务器的数据
                 "meterflag": "你要传到后端去的数据值",
                 "userflag": "你要传到后端去的数据值",
             }, 
            "type" : "post",   //规定请求的类型(GET 或 POST)
            "success" : function(data) {
                  console.log(data);    //你可以在这打印看一下请求成功返回的数据
            };  //当请求成功时运行的函数
            "erro": function(err) {};   //如果请求失败要运行的函数
            //...其他的参数可自行百度
        });

你要实现前端页面功能,还是后端功能呢?
每个页面请求都是相同的流程,我们细细的拆看看一下:

  1. 前端页面访问接口,按照请求格式发送数据
    2 .后端服务器接收到请求格式数据,执行后台方法
  2. 后端执行成功,按照响应格式返回数据
  3. 前端拿到响应格式的返回数据

所以对应你的接口文档:

  1. 前端ajax调用. 请求地址全部都是接口,你还需要知道测试的ip和端口是什么,可以询问你的组长或者学长老师
  2. 记得调用接口时,按照请求格式,发送数据
  3. console.log(data), 打印ajax执行后的返回数据,你会发现,正常就是按照响应格式返回的。

img


把这文档打回去让重新写一份,响应数据字段名都没统一

请求路径中portal可能是配置文件配置的一个公共路径,代表后台服务,后面三个是controller中配置的实际路径,每一个controller对应的路径有所不同

img

img