api 编程 视频教程

API 编程视频教程

API 编程基础

什么是 API？

• 定义：应用程序编程接口（API）是软件应用之间的通信协议,允许不同系统交换数据。
• 作用：解耦前后端、实现跨平台数据共享（如微信支付 API、地图 API）。
• 常见类型：RESTful API、GraphQL、SOAP。

HTTP 请求方法

方法	作用	示例场景
GET	获取资源	查询用户列表
POST	创建资源	提交表单数据
PUT	更新资源	修改用户信息
DELETE	删除资源	删除指定订单

API 请求与响应结构

• 请求：包含 URL、Headers（如 Content-Type: application/json）、Body（POST/PUT 时）。
• 响应：状态码（200/404/500）、响应体（JSON/XML）、Headers（如 Server: nginx）。

---

API 开发工具与技术

常用工具

工具	用途	特点
Postman	测试 API	可视化界面，支持环境变量
cURL	命令行请求	轻量级，适合脚本化
Insomnia	替代 Postman	开源，支持插件

认证方式

类型	原理	适用场景
Basic Auth	用户名+密码 Base64 编码	简单场景（不安全）
Token	颁发访问令牌（如 JWT）	无状态认证，推荐 Web API
OAuth 2.0	授权码流程	第三方授权（如微信登录）

错误处理

• HTTP 状态码：
  • 2xx：成功（200 OK, 201 Created）
  • 4xx：客户端错误（400 Bad Request, 401 Unauthorized）
  • 5xx：服务器错误（500 Internal Server Error）
• 自定义错误码：在响应体中返回业务错误码（如 {"error_code": 1001, "message": "参数错误"}）。

---

实战：构建 RESTful API

使用 Node.js + Express 创建 API

const express = require('express');
const app = express();
app.use(express.json()); // 解析 JSON 请求体
// GET /users
app.get('/users', (req, res) => {
  res.json([{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }]);
});
// POST /users
app.post('/users', (req, res) => {
  const newUser = req.body; // { name: 'Charlie' }
  res.status(201).json(newUser);
});
app.listen(3000, () => console.log('API running on port 3000'));

API 测试流程

1. 启动服务：node server.js
2. 发送请求：
   • GET http://localhost:3000/users → 返回用户列表
   • POST http://localhost:3000/users → Body: { "name": "Charlie" }
3. 验证响应：检查状态码和返回数据。

---

常见问题与解决方案

CORS 跨域问题

• 现象：浏览器阻止跨域请求（如 Access-Control-Allow-Origin 错误）。
• 解决：在服务器设置响应头：

  app.use((req, res, next) => {
    res.header('Access-Control-Allow-Origin', '*'); // 允许所有域名
    res.header('Access-Control-Allow-Methods', 'GET,POST'); // 允许的方法
    next();
  });

API 速率限制

• 问题：防止恶意请求或滥用接口（如频繁调用导致服务器过载）。
• 方案：使用中间件（如 express-rate-limit）：

  const rateLimit = require('express-rate-limit');
  app.use(rateLimit({
    windowMs: 15 * 60 * 1000, // 15分钟窗口
    max: 100, // 每IP最多100次请求
    message: 'Too many requests, please try again later'
  }));

---

相关问题与解答

Q1：如何选择 API 认证方式？

A：根据安全性需求：

• Basic Auth：仅适合内部系统，传输需 HTTPS。
• Token（JWT）：适合 Web API,客户端存储令牌。
• OAuth 2.0：第三方授权场景（如微信、GitHub 登录）。

Q2：如何调试 API 请求参数错误？

A：

1. 检查 URL：确保路径和查询参数正确（如 /users?id=1）。
2. 验证 Body：使用 Postman 或控制台打印 req.body。
3. 日志记录：服务器端打印请求参数（console.log(req.params)

以上内容就是解答有关“api 编程 视频教程”的详细内容了，我相信这篇文章可以为您解决一些疑惑，有任何问题欢迎留言反馈，谢谢阅读。