在项目开发中如何去分析接口文档

什么是接口文档？

        我们在使用ajax开始 就基本都是在请求接口 既然是请求接口  就必然有对应的接口文档，如果没有文档你就不知道这个接口怎么用 

        接口是后端 比如（java、python、php）等开发人员开发出来的

        作为一名前端开发工程师，我们关心的是后端把这个接口写出来，我们如何使用

        一般都是通过文档的形式进行沟通 

文档如何使用？

        文档一般都有标题来介绍接口的功能 

        一个功能一般分为三段介绍

                基本信息：一般都要请求地址 请求类型 接口描述 HTTP状态码等。。。

                请求参数：请求头 请求体等

                响应数据：响应回来的数据是什么字段是什么意思

接口的类型

       例如我们使用axios这方法来发请求

axios({
    method: 'post',   // Methodq 请求方法，

})

        Methodq 请求方法，常见的有:

        EGT（一般用于查询数据）

        POST（一般用于添加）

        PUT（一般用于修改，完整替换）

        DELETE（一般用于删除操作）

        PATCH（一般用于修改操作，局部修改）

        从使用角度不用关系为什么，因为这是后端设计的，我们决定不了

        URL请求路径

axios({
    path: "请求路径"
})

        请求路径中的 ：xxx 表示路径的参数 例如（abc/abc/abc/:id）

        使用的时候需要指定参数，把数据值替换掉 abc/abc/abc/123

请求头

           通过 axios 发送请求设置请求头参数

axios({
    headers: {
        // 名字：值
        'Content-Type': ''
    }
})

请求体

        请求参数 常见的一般GET方法就是Query参数， POST方法就是Body参数

{
    // 例如传递一个名字
    name: "张三"
}

        一般文档中会标注要传递的参数 

         在axios中通过data选项设置Body请求体参数
         在axios中通过params选项设置Query请求体参数

axios(
    {
        data: "body请求体数据"
    },
    params: {
        params: "params请求参数"
    }
)