如何在FastAPI中实现跨域资源共享（CORS）

如何在FastAPI中实现跨域资源共享（CORS）

引言：

跨域资源共享（Cross-Origin Resource Sharing，简称CORS）是一种用于解决浏览器跨域访问的机制。在现代的Web应用程序中，很常见需要从不同的域名访问资源，如API服务。然而，浏览器出于安全原因，默认情况下不允许跨域请求。为了解决这一问题，我们可以在FastAPI中使用CORS来允许跨域资源共享。

本文将介绍如何使用FastAPI实现CORS，并提供相应的代码示例，帮助你快速上手。

步骤一：安装依赖项

在开始之前，请确保你已经安装好了FastAPI库。如果没有安装，你可以在命令行中使用以下命令进行安装：

pip install fastapi[all]

步骤二：导入必要的模块

首先，我们需要导入FastAPI和Starlette框架的一些模块。在你的代码文件顶部添加以下代码：

from fastapi import FastAPI
from fastapi.middleware.cors import CORSMiddleware

步骤三：创建FastAPI实例并添加CORS中间件

接下来，我们需要创建一个FastAPI应用实例，并将CORS中间件添加到应用中。在你的代码中添加以下代码：

app = FastAPI()

# 配置CORS
origins = [
    "http://localhost",
    "http://localhost:8000",
    "http://localhost:3000",
    "http://example.com"
]

app.add_middleware(
    CORSMiddleware,
    allow_origins=origins,
    allow_credentials=True,
    allow_methods=["*"],
    allow_headers=["*"],
)

上述代码中，我们创建了一个app实例，并使用app.add_middleware方法添加CORS中间件。allow_origins参数指定允许跨域访问的域名列表，这里我们添加了一些示例的域名。你可以根据你的实际需求修改这个列表。allow_credentials参数指定是否允许前端发送认证信息，如cookies。allow_methods和allow_headers参数指定允许的HTTP方法和头部信息。

步骤四：编写API路由

现在，我们可以开始编写你的API路由了，这与你正常编写FastAPI应用的方式一样。在你的代码中添加以下示例代码：

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

上述代码定义了一个GET请求的API路由/items/，该路由返回一个简单的JSON响应。

步骤五：运行FastAPI应用

最后，你可以使用以下命令运行你的FastAPI应用：

uvicorn yourfile:app --reload

这里的yourfile是你的代码文件名，app是你创建的FastAPI应用实例的名称。

完成以上步骤后，你可以通过指定的域名来访问你的API，并进行跨域请求。FastAPI会自动处理CORS相关的头部字段，以允许跨域资源共享。

总结：

通过本文的介绍，你学会了如何在FastAPI中实现跨域资源共享（CORS）。你可以按照上述步骤，轻松地在你的FastAPI应用中添加CORS中间件，并允许跨域访问。这样你就可以在Web应用程序中方便地进行跨域API调用了。希望本文对你有所帮助！