FastAPI零基础入门：10分钟搭建你的第一个API

快速体验

1. 打开 InsCode(快马)平台 https://www.inscode.net
2. 输入框内输入如下内容：

   创建一个极简的FastAPI学习项目，包含：1. 安装指南（pipenv虚拟环境） 2. 最简单的GET/POST接口示例 3. 路径参数和查询参数演示 4. 基本的Pydantic模型示例 5. 自动文档访问测试。要求每个步骤都有详细注释，适合完全新手理解。

3. 点击'项目生成'按钮，等待项目生成完整后预览效果

最近在学习用FastAPI开发Web应用，发现它真的对新手非常友好。今天就跟大家分享一下我的学习笔记，从零开始用10分钟搭建一个简单的API服务。

1. 环境准备

首先需要安装Python环境，推荐使用Python 3.7以上版本。为了项目环境隔离，我选择了pipenv作为虚拟环境工具。

1. 安装pipenv：在终端运行pip install pipenv
2. 创建项目目录并进入：mkdir fastapi-demo && cd fastapi-demo
3. 初始化虚拟环境：pipenv install fastapi uvicorn

这里安装了fastapi框架和uvicorn服务器，uvicorn是ASGI服务器，用来运行FastAPI应用。

2. 创建第一个API

新建一个main.py文件，我们来写一个最简单的FastAPI应用：

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
    return {"message": "Hello World"}

这段代码创建了一个FastAPI实例，并定义了一个根路径的GET接口。启动服务只需要在终端运行：

pipenv run uvicorn main:app --reload

--reload参数让服务器在代码变更时自动重载，适合开发环境。

3. 添加POST接口

让我们扩展一下功能，添加一个POST接口：

@app.post("/items/")
def create_item(item: dict):
    return {"item": item}

这个接口可以接收JSON格式的请求体，并原样返回。

4. 路径参数和查询参数

FastAPI处理路径参数和查询参数非常简单：

@app.get("/items/{item_id}")
def read_item(item_id: int, q: str = None):
    return {"item_id": item_id, "q": q}

这里item_id是路径参数，q是可选查询参数。FastAPI会自动进行类型转换和验证。

5. 使用Pydantic模型

Pydantic提供了数据验证和设置管理。我们先定义一个简单的Item模型：

from pydantic import BaseModel

class Item(BaseModel):
    name: str
    description: str = None
    price: float
    tax: float = None

然后可以在接口中使用这个模型：

@app.put("/items/{item_id}")
def update_item(item_id: int, item: Item):
    return {"item_id": item_id, "item_name": item.name}

6. 自动生成的文档

FastAPI的一个很棒的特性是自动生成交互式API文档。启动服务后，访问：

• http://localhost:8000/docs (Swagger UI)
• http://localhost:8000/redoc (ReDoc)

这些文档页面会显示所有接口，并且可以直接测试。

项目部署

FastAPI应用的部署非常简单。在InsCode(快马)平台上，只需要上传项目代码，就能一键部署到线上环境，完全不用操心服务器配置。

平台还提供了实时预览功能，可以立即看到API的运行效果。对于新手来说，这种开箱即用的体验真的很友好，省去了很多环境配置的麻烦。

总结

通过这个简单的项目，我们学会了：

1. 如何使用pipenv管理Python虚拟环境
2. 创建基本的FastAPI应用
3. 定义GET和POST接口
4. 处理路径参数和查询参数
5. 使用Pydantic进行数据验证
6. 利用自动生成的API文档

FastAPI的学习曲线很平缓，特别适合Python开发者快速构建API服务。如果你也想尝试，不妨从这个小项目开始，在InsCode(快马)平台上实际操作一下，体验快速部署的便利。

快速体验

1. 打开 InsCode(快马)平台 https://www.inscode.net
2. 输入框内输入如下内容：

   创建一个极简的FastAPI学习项目，包含：1. 安装指南（pipenv虚拟环境） 2. 最简单的GET/POST接口示例 3. 路径参数和查询参数演示 4. 基本的Pydantic模型示例 5. 自动文档访问测试。要求每个步骤都有详细注释，适合完全新手理解。

3. 点击'项目生成'按钮，等待项目生成完整后预览效果