HTTP协议与RESTful API实战手册（二）：用披萨店故事说透API设计奥秘

当前位置:

首页 > Python基础教程 >

HTTP协议与RESTful API实战手册（二）：用披萨店故事说透API设计奥秘

第一章：HTTP协议就像披萨外卖（场景化学习）
1.1 订单生命周期对照表

外卖步骤 HTTP对应概念示例

外卖步骤	HTTP对应概念	示例
顾客下单	POST请求	POST /orders
打印小票	Header元数据	Content-Type: application/json
后厨制作	服务器处理逻辑	数据库写入操作
外卖异常通知	4xx/5xx状态码	404 披萨缺货
1.2 必知
必会的5个状态码

PYTHON

@app.post("/orders")
async def create_order():
    try:
        # 处理订单逻辑
        return JSONResponse(201, headers={"Location": "/orders/1001"})
    except OutOfStock:
        return JSONResponse(409, content={"error": "玛格丽特披萨库存不足"})

第二章：RESTful设计七大黄金法则
2.1 错误 vs 正确设计对比

PYTHON

# 错误：动词导向 ❌
@app.post("/getUserOrders")
def get_orders(): ...

# 正确：名词导向 ✅  
@app.get("/users/{user_id}/orders")
def get_orders(user_id: int): ...

2.2 超媒体API实战（HATEOAS）

JSON

// 订单创建响应
{
  "id": 1001,
  "status": "烤制中",
  "_links": {
    "self": {"href": "/orders/1001", "method": "GET"},
    "cancel": {"href": "/orders/1001", "method": "DELETE"}
  }
}

第三章：从零搭建披萨店API

栏目列表