接口相关的基础概念
使用 Ajax 请求数据时,被请求的 URL 地址,就叫做数据接口(简称:接口或 API 接口)。同时,每个接口必须有对应的请求方式。
接口文档就是接口的使用说明书,它是我们调用接口的依据。
请参考一个现成的接口文档 https://www.showdoc.com.cn/ajaxapi?page_id=3753563065735122
其中包含了接口的描述信息:
组成部分 | 说明 |
---|---|
接口名称 | 接口的名称,用来快速区分每个接口的作用。如:登录接口、添加图书接口 |
接口 URL | 客户端发起 Ajax 调用此接口时,请求的 URL 地址 |
请求方式 | 接口的请求方式,如:GET、POST、PUT、DELETE 等 |
请求参数 | 请求此接口时,需要发送到服务器的查询参数或请求体 |
返回示例 | 当接口请求成功后,服务器响应回来的数据的基本格式 |
返回参数说明 | 接口响应结果的详细描述 |