API设计模式

一致且对开发者友好的REST API设计约定和最佳实践。

何时激活

设计新的API端点时
审核现有的API合同时
添加分页、过滤或排序时
实现API错误处理时
规划API版本策略时
构建公共或合作伙伴面向的API时

资源设计

URL结构

# 资源是名词，复数，小写，kebab-case
GET    /api/v1/users
GET    /api/v1/users/:id
POST   /api/v1/users
PUT    /api/v1/users/:id
PATCH  /api/v1/users/:id
DELETE /api/v1/users/:id

# 关系的子资源
GET    /api/v1/users/:id/orders
POST   /api/v1/users/:id/orders

# 不映射到CRUD的动作（慎用动词）
POST   /api/v1/orders/:id/cancel
POST   /api/v1/auth/login
POST   /api/v1/auth/refresh

命名规则

# 好的
/api/v1/team-members          # 多词资源用kebab-case
/api/v1/orders?status=active  # 查询参数用于过滤
/api/v1/users/123/orders      # 嵌套资源表示所有权

# 坏的
/api/v1/getUsers              # URL中的动词
/api/v1/user                  # 单数（使用复数）
/api/v1/team_members          # URLs中的snake_case
/api/v1/users/123/getOrders   # 嵌套资源中的动词

HTTP方法和状态码

方法语义

方法	幂等	安全	用途
GET	是	是	检索资源
POST	否	否	创建资源，触发动作
PUT	是	否	完全替换资源
PATCH	否*	否	部分更新资源
DELETE	是	否	移除资源

*PATCH可以通过适当的实现变得幂等

状态码参考

# 成功
200 OK                    — GET, PUT, PATCH（带响应体）
201 Created               — POST（包含Location头）
204 No Content            — DELETE, PUT（无响应体）

# 客户端错误
400 Bad Request           — 验证失败，畸形的JSON
401 Unauthorized          — 缺少或无效的身份验证
403 Forbidden             — 已认证但无权限
404 Not Found             — 资源不存在
409 Conflict              — 重复条目，状态冲突
422 Unprocessable Entity  — 语义上无效（有效的JSON，坏数据）
429 Too Many Requests     — 速率限制超出

# 服务器错误
500 Internal Server Error — 意外的失败（永远不要暴露细节）
502 Bad Gateway           — 上游服务失败
503 Service Unavailable   — 临时过载，包括Retry-After

常见错误

# 坏的：什么都用200
{ "status": 200, "success": false, "error": "Not found" }

# 好的：语义化地使用HTTP状态码
HTTP/1.1 404 Not Found
{ "error": { "code": "not_found", "message": "User not found" } }

# 坏的：验证错误用500
# 好的：400或422带字段级细节

# 坏的：创建资源用200
# 好的：201带Location头
HTTP/1.1 201 Created
Location: /api/v1/users/abc-123

响应格式

成功响应

{
  "data": {
    "id": "abc-123",
    "email": "alice@example.com",
    "name": "Alice",
    "created_at": "2025-01-15T10:30:00Z"
  }
}

集合响应（带分页）

{
  "data": [
    { "id": "abc-123", "name": "Alice" },
    { "id": "def-456", "name": "Bob" }
  ],
  "meta": {
    "total": 142,
    "page": 1,
    "per_page": 20,
    "total_pages": 8
  },
  "links": {
    "self": "/api/v1/users?page=1&per_page=20",
    "next": "/api/v1/users?page=2&per_page=20",
    "last": "/api/v1/users?page=8&per_page=20"
  }
}

错误响应

{
  "error": {
    "code": "validation_error",
    "message": "Request validation failed",
    "details": [
      {
        "field": "email",
        "message": "Must be a valid email address",
        "code": "invalid_format"
      },
      {
        "field": "age",
        "message": "Must be between 0 and 150",
        "code": "out_of_range"
      }
    ]
  }
}

响应信封变体

// 选项A：带有数据包装的信封（推荐用于公共API）
interface ApiResponse<T> {
  data: T;
  meta?: PaginationMeta;
  links?: PaginationLinks;
}

interface ApiError {
  error: {
    code: string;
    message: string;
    details?: FieldError[];
  };
}

// 选项B：平面响应（更简单，常见于内部API）
// 成功：直接返回资源
// 错误：返回错误对象
// 通过HTTP状态码区分

分页

基于偏移（简单）

GET /api/v1/users?page=2&per_page=20

# 实现
SELECT * FROM users
ORDER BY created_at DESC
LIMIT 20 OFFSET 20;

优点： 易于实现，支持“跳转到第N页” 缺点： 大偏移时速度慢（OFFSET 100000），并发插入时不一致

基于游标（可扩展）

GET /api/v1/users?cursor=eyJpZCI6MTIzfQ&limit=20

# 实现
SELECT * FROM users
WHERE id > :cursor_id
ORDER BY id ASC
LIMIT 21;  -- 多获取一个以确定has_next

{
  "data": [...],
  "meta": {
    "has_next": true,
    "next_cursor": "eyJpZCI6MTQzfQ"
  }
}

优点： 无论位置如何，性能一致，与并发插入稳定 缺点： 不能跳转到任意页面，游标是不透明的

使用哪种

使用案例	分页类型
管理仪表板，小数据集（<10K）	偏移
无限滚动，Feeds，大数据集	游标
公共API	游标（默认）带偏移（可选）
搜索结果	偏移（用户期望页码）

过滤、排序和搜索

过滤

# 简单的等式
GET /api/v1/orders?status=active&customer_id=abc-123

# 比较操作符（使用括号表示法）
GET /api/v1/products?price[gte]=10&price[lte]=100
GET /api/v1/orders?created_at[after]=2025-01-01

# 多个值（逗号分隔）
GET /api/v1/products?category=electronics,clothing

# 嵌套字段（点表示法）
GET /api/v1/orders?customer.country=US

排序

# 单字段（前缀-表示降序）
GET /api/v1/products?sort=-created_at

# 多字段（逗号分隔）
GET /api/v1/products?sort=-featured,price,-created_at

全文搜索

# 搜索查询参数
GET /api/v1/products?q=wireless+headphones

# 字段特定搜索
GET /api/v1/users?email=alice

稀疏字段集

# 返回指定字段（减少负载）
GET /api/v1/users?fields=id,name,email
GET /api/v1/orders?fields=id,total,status&include=customer.name

认证和授权

基于令牌的认证

# Authorization头中的Bearer令牌
GET /api/v1/users
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

# API密钥（服务器到服务器）
GET /api/v1/data
X-API-Key: sk_live_abc123

授权模式

// 资源级别：检查所有权
app.get("/api/v1/orders/:id", async (req, res) => {
  const order = await Order.findById(req.params.id);
  if (!order) return res.status(404).json({ error: { code: "not_found" } });
  if (order.userId !== req.user.id) return res.status(403).json({ error: { code: "forbidden" } });
  return res.json({ data: order });
});

// 基于角色：检查权限
app.delete("/api/v1/users/:id", requireRole("admin"), async (req, res) => {
  await User.delete(req.params.id);
  return res.status(204).send();
});

速率限制

头

HTTP/1.1 200 OK
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640000000

# 超出时
HTTP/1.1 429 Too Many Requests
Retry-After: 60
{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded. Try again in 60 seconds."
  }
}

速率限制等级

等级	限制	窗口	使用案例
匿名	30/min	每个IP	公共端点
认证	100/min	每个用户	标准API访问
高级	1000/min	每个API密钥	付费API计划
内部	10000/min	每个服务	服务到服务

版本控制

URL路径版本控制（推荐）

/api/v1/users
/api/v2/users

优点： 明确，易于路由，可缓存 缺点： 版本之间的URL变化

头部版本控制

GET /api/users
Accept: application/vnd.myapp.v2+json

优点： 清洁URL 缺点： 更难测试，容易忘记

版本控制策略

1. 从/api/v1/开始 — 需要时再版本化
2. 同时最多维护2个活动版本（当前+上一个）
3. 弃用时间线：
   - 宣布弃用（公共API提前6个月通知）
   - 添加Sunset头：Sunset: Sat, 01 Jan 2026 00:00:00 GMT
   - 在日落日期后返回410 Gone
4. 非破坏性变更不需要新版本：
   - 在响应中添加新字段
   - 添加新的可选查询参数
   - 添加新端点
5. 破坏性变更需要新版本：
   - 移除或重命名字段
   - 更改字段类型
   - 更改URL结构
   - 更改认证方法

实现模式

TypeScript（Next.js API路由）

import { z } from "zod";
import { NextRequest, NextResponse } from "next/server";

const createUserSchema = z.object({
  email: z.string().email(),
  name: z.string().min(1).max(100),
});

export async function POST(req: NextRequest) {
  const body = await req.json();
  const parsed = createUserSchema.safeParse(body);

  if (!parsed.success) {
    return NextResponse.json({
      error: {
        code: "validation_error",
        message: "Request validation failed",
        details: parsed.error.issues.map(i => ({
          field: i.path.join("."),
          message: i.message,
          code: i.code,
        })),
      },
    }, { status: 422 });
  }

  const user = await createUser(parsed.data);

  return NextResponse.json(
    { data: user },
    {
      status: 201,
      headers: { Location: `/api/v1/users/${user.id}` },
    },
  );
}

Python（Django REST Framework）

from rest_framework import serializers, viewsets, status
from rest_framework.response import Response

class CreateUserSerializer(serializers.Serializer):
    email = serializers.EmailField()
    name = serializers.CharField(max_length=100)

class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = ["id", "email", "name", "created_at"]

class UserViewSet(viewsets.ModelViewSet):
    serializer_class = UserSerializer
    permission_classes = [IsAuthenticated]

    def get_serializer_class(self):
        if self.action == "create":
            return CreateUserSerializer
        return UserSerializer

    def create(self, request):
        serializer = CreateUserSerializer(data=request.data)
        serializer.is_valid(raise_exception=True)
        user = UserService.create(**serializer.validated_data)
        return Response(
            {"data": UserSerializer(user).data},
            status=status.HTTP_201_CREATED,
            headers={"Location": f"/api/v1/users/{user.id}"},
        )

Go（net/http）

func (h *UserHandler) CreateUser(w http.ResponseWriter, r *http.Request) {
    var req CreateUserRequest
    if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
        writeError(w, http.StatusBadRequest, "invalid_json", "Invalid request body")
        return
    }

    if err := req.Validate(); err != nil {
        writeError(w, http.StatusUnprocessableEntity, "validation_error", err.Error())
        return
    }

    user, err := h.service.Create(r.Context(), req)
    if err != nil {
        switch {
        case errors.Is(err, domain.ErrEmailTaken):
            writeError(w, http.StatusConflict, "email_taken", "Email already registered")
        default:
            writeError(w, http.StatusInternalServerError, "internal_error", "Internal error")
        }
        return
    }

    w.Header().Set("Location", fmt.Sprintf("/api/v1/users/%s", user.ID))
    writeJSON(w, http.StatusCreated, map[string]any{"data": user})
}

API设计清单

在发布新端点前：

[ ] 资源URL遵循命名约定（复数，kebab-case，无动词）
[ ] 使用正确的HTTP方法（GET用于读取，POST用于创建等）
[ ] 返回适当的状态码（不是什么都用200）
[ ] 输入通过模式验证（Zod，Pydiatic，Bean Validation）
[ ] 错误响应遵循标准格式，带有代码和消息
[ ] 列表端点实现分页（游标或偏移）
[ ] 需要认证（或明确标记为公共）
[ ] 检查授权（用户只能访问自己的资源）
[ ] 配置速率限制
[ ] 响应不泄露内部细节（堆栈跟踪，SQL错误）
[ ] 与现有端点命名一致（camelCase vs snake_case）
[ ] 文档化（OpenAPI/Swagger规范已更新）