前言
作为前端人员,我们看后端给我们的接口文档,无非就是想知道如何正确调用接口,以完成工作任务
那么正确调用一个接口,需要注意哪些方面:
- 域名/IP
- 端口号
- 路径
- 接口请求方式
- 接口参数
上面五个方面
其实还有请求协议,请求协议有http,https,还有wesocket的ws协议,不过,对于平常的开发环境,http用的是最多的,这里就不展开讲了
在 Apifox,如何确定上面五个方面?下面一起看看
Apifox 官网:apifox.com/
选择项目
先选择我们开发的项目
域名/IP、端口号
在 Apifox,有不同的环境可以选择。不同的环境,意味着接口调用的域名等信息不同
我们可以点击管理环境
,查看每个环境的配置的具体域名等信息
开发人员可以根据实际情况,选择不同的环境
路径、请求方式
我们随意选择一个项目中的接口
就可以看到接口的详细信息:
这是一个添加待办事项的接口
它的路径是/tasks
请求方式是:POST
很简单
请求参数
对于接口的参数比上面的信息读取稍微复杂一点,但也不难
首先我们知道,一个接口的参数有哪几种形式:
- path
- query
- body
- header
path
path 的参数,是直接拼在 url 后面的信息
例如:/tasks/status/15
,后端项目将会读取 url 后面的15
作为 task 的 id
在 Apifox 中,path 的参数介绍是这样显示的:
query
query 的参数,也是拼在 url 后面,但是以键值对的方式拼接的
例如:/tasks?user_id=1&isCompleted=true
,后端项目将会读取后面的键值对user_id=1&isCompleted=true
,然后转化得到一个到这样的参数信息:{user_id: 1, isCompleted: true}
在 Apifox 中, query 的参数介绍是这样显示的:
body
body 的参数,是指放在请求体中的数据
在 Apifox 中,body 的参数介绍是这样的:
header
header 中一般存放身份校验的信息,可能放在 cookie 中,也可能是自定义的请求头:
在 Apifox 中,header 信息是这样显示的:
小结
上面介绍了在 Apifox 中,查看接口的介绍,获取调用接口必要的信息。其实 Apifox 的功能,不仅于此。除了有接口文档的作用,还有调试接口的作用。
在 Apifox 中调试接口
了解了接口的基本信息后,我们其实就已经可以着手写代码了。但为了避免后端粗心,给了一个错误的文档,或者当我们写代码时候,接口老是调不通,从而产生自我怀疑,等等情况,我们前端人员也要掌握必要的调试接口的技能
在 Apifox 中,如何调试接口呢?
很简单,调试接口,无非就是那五个东西:域名/IP,端口号,路径,请求方式,请求参数
当然,我们不用重新开始配置这五个东西,后端在写接口文档的时候,都已经配好了。所以我们直接用接口文档的配置进行调试就好
举个例子:
有这样一个接口,用来查询用户所有的待办事项:
接口的路径是/tasks
,请求方式是GET
接口接收三个请求,一个必填的,两个选填的。
然后点击运行按钮,进入调试
页面会切换到运行的面板:
我们可以看到,Apifox 已经帮我们填好了域名,端口号,路径,还有请求方式,请求参数。
如果我们想更换请求的域名和端口号,我们可以直接在输入框里修改,也可以更换右上角的环境(目前是开发环境)
全都帮我们搞定了,太棒了,剩下的只需要点击发送按钮就可以了。下面是返回结果:
结果正常返回。之后我们没还可以修改请求参数的值,看看接口返回的结果,会不会有不同。
这就是 Apifox 调试体验,是不是非常棒。Apifox 将接口文档和调试工具合为一体,这不仅对后端开发是个趁手的工具,对前端开发也是很方便的
总结
这篇文章介绍了如何利用 Apifox 进行接口文档的阅读和接口的调试,下篇详细介绍,具体如何在代码中调用接口。