一、先搞懂3个核心名词:接口 / API / 接口文档
1、什么是接口?
手机APP 和 后端服务器 互不直接连通 所有数据(登录、查数据、下单、传图片)全部通过接口传输
2、什么是 API?
接口:是统称(泛指数据通道) API:是行业规范化的接口,是可以被程序直接调用的标准接口
3、什么是接口文档?
这个接口用来干什么 地址是什么、用什么方式请求 需要传哪些参数、哪些必填 成功/失败会返回什么数据
二、HTTP / HTTPS 到底有什么区别?
1、HTTP 协议
2、HTTPS 协议
通用通信流程(必记)
三、接口完整结构拆解,新手一看就懂
https://api.weather.com/getWeather?city=北京1、请求 URL:接口的唯一地址
2、请求方式:告诉服务器你要做什么
GET:查询数据(查天气、查用户列表、查订单)✅ 只查不改,只读不写 POST:新增数据(注册账号、提交表单、创建订单)✅ 新增一条全新数据 PUT:全量修改数据(完整替换用户信息)✅ 覆盖更新所有内容 PATCH:局部修改数据(只改手机号、只改密码)✅ 只更新个别字段,更轻量 DELETE:删除数据(删除订单、删除收藏)✅ 删掉整条数据记录
3、请求头 Header:请求的附加身份说明
Content-Type:告诉服务器,我传的参数是什么格式(JSON/表单等) Token:用户登录令牌,相当于通行证,没 Token 无法访问需要登录的接口 User-Agent:标识客户端类型(手机/电脑/浏览器)
4、请求参数:你发给服务器的条件数据
查询参数:URL 问号后面的内容,如 ?city=北京 路径参数:拼接在 URL 路径中,如 /user/1001,1001是用户ID 请求体参数:POST/PUT 专用,放在请求体内,适合传账号密码、表单、批量数据
5、响应数据 + 状态码:服务器给你的结果
① 响应数据
{ "code":200, "msg":"查询成功", "data":{"weather":"晴","temp":"26℃"} }② HTTP 状态码(统一标准)
2xx 成功:200 请求一切正常 3xx 重定向:301 页面/接口永久跳转 4xx 客户端错误:404地址不存在、401未登录、403权限不足 5xx 服务端错误:500代码异常、503服务器不可用
重点区分:HTTP状态码是通用网络状态;响应里的 code 是后端自定义业务码,用来判断业务是否执行成功,二者完全不同! |
四、手把手教你读懂一份接口文档
接口名称:获取城市天气请求地址:https://api.weather.com/getWeather请求方式:GET请求参数:city(必填、字符串、城市名称)成功返回:{"code":200,"msg":"查询成功","data":{"weather":"晴"}}失败返回:{"code":400,"msg":"城市名称不能为空"}}
五、本篇总结:你能收获什么?
✅ 分清接口、API、接口文档的核心区别与作用 ✅ 吃透 HTTP/HTTPS 协议差异,理解数据通信逻辑 ✅ 精通接口五大核心组成(URL/请求方式/请求头/参数/响应) ✅ 独立读懂基础接口文档,扫清入门术语障碍
夜雨聆风