一、接口一般包含什么
1.请求方式: GET POST PUT DELETE
| 名称 | GET | POST | PUT | DELETE |
|---|---|---|---|---|
| 功能 | 查 | 增 | 改 | 删 |
2.接口路径/URL地址
3.响应示例
4.响应参数
二、怎么“读”接口
查看请求方式,在前端可以不写完整地址,复制swagger里的url就可以,看看要传哪些参数,返回值里有哪些字段。
三、几个词汇
1.swagger:接口文档规范
2.openAPI:也就是swagger
3.swagger UI:根文档生成的网页
4.swagger文档:按规范写的接口说明(通常是 YAML/JSON)
四、接口怎么接上去的
页面调 API 函数 → API 里写 url + method + 参数 → 通过 request 发请求(带 baseURL、Token)→ 代理/服务器转到后端 → 页面根据返回更新界面。