什么是 API?
想象一下,你在一家餐馆,你想点一些食物。为了得到你想要的食物,你和服务员交谈,告诉他们你的订单。然后,服务员将您的订单带到厨房,厨师会根据您的要求准备食物。最后,服务员把你的食物带回给你,你就可以享用你的饭菜了。 在这个场景中,服务员就像一个API(应用程序编程接口)。API 是不同软件应用程序交流和交换信息的一种方式,就像您与服务员沟通以将您的食物订单送到厨房一样。
API 允许不同的计算机程序、应用程序或网站相互通信并共享数据,而不是人。例如,当您使用移动应用程序查看天气时,该应用程序使用 API 从天气服务获取当前天气信息。应用向 API 发送请求,要求提供天气数据,API 使用请求的信息进行响应。
API 使不同的应用和服务能够协同工作并无缝共享信息。它们定义了一组规则和协议,这些规则和协议指定一个程序如何从另一个程序请求数据以及如何将数据发送回。将 API 视为一种语言,它允许不同的应用程序相互理解和协作。它们使开发人员能够利用其他服务提供的功能来构建新应用程序或集成现有应用程序。因此,API 就像信使一样,帮助不同的软件应用程序相互通信、交换数据并协同工作,为我们提供数字世界中所需的服务和信息。
什么是 FastAPI?
FastAPI 是一个 Python Web 框架,可帮助您快速轻松地构建 API(应用程序编程接口)。它提供了一组工具和功能,使创建可以通过 Internet 接收和发送数据的 Web 应用程序变得简单。
如上所述,将 API 视为不同应用程序相互通信的一种方式。例如,当您使用移动应用程序并从互联网上获取数据时,它可能正在使用 API 来获取该信息。FastAPI 可帮助您构建应用程序的一部分,该部分提供其他应用程序可以使用的数据和服务。
FastAPI 旨在快速(顾名思义)和高效。它使用一种称为异步编程的现代方法,它允许多个任务同时运行而不会相互阻塞。这意味着您的 API 可以处理来自不同用户的许多请求,而不会减慢速度。FastAPI 还具有用户友好的界面。它的设计易于理解和使用,即使您是 Web 开发的新手。它使用 Python,这是一种流行的编程语言,以其简单性和可读性而闻名。使用 FastAPI,您可以编写干净且有条理的代码来构建 API。关于FastAPI的一个很酷的事情是,它会根据你编写的代码自动为你的API生成文档。本文档可帮助其他开发人员了解如何使用您的 API 以及它需要哪些数据。这就像拥有一本 API 手册,而不必自己编写。
总体而言,FastAPI 是一个强大的工具,可以简化构建 API 的过程。它可以帮助您创建可以与其他应用程序通信、高效处理多个请求并自动生成文档的 Web 应用程序。如果您想快速轻松地使用 Python 创建 API,这是一个不错的选择。
什么是异步编程?
想象一下,你有一堆任务要做,比如家庭作业或家务。通常,您一次只执行一项任务,完成它,然后继续执行下一个任务。但是,有时您会遇到需要很长时间才能完成的任务,例如等待网页加载或下载大文件。这就像排队等待某事发生,然后才能继续执行下一个任务。现在,想象一下,如果您可以在等待这些缓慢的任务完成时做其他事情。例如,在等待网页加载时,您可以开始处理另一项作业或做一些有趣的事情,例如在手机上玩快速游戏。这样,您就不会浪费时间等待一项任务完成后再开始另一项任务。
FastAPI 建立在 Python 编程语言之上,利用 Python 对异步编程的原生支持来处理异步操作。在 FastAPI 中,你可以使用 async 和 await 关键字定义异步路由和函数。通过将函数或路由标记为 async,可以指示它可以执行异步操作。这允许函数或路由在等待外部资源(例如数据库查询或 API 调用)时暂停执行,而不会阻止整个应用程序。
下面是一个更实际的示例,演示了 FastAPI 如何处理异步操作,特别是异步从外部 API 获取数据
from fastapi import FastAPI
import httpx
app = FastAPI()async def fetch_data(url):
async with httpx.AsyncClient() as client:
response = await client.get(url)
return response.json()@app.get("/data")
async def get_data():
data_url = "https://api.example.com/data"
data = await fetch_data(data_url)
return {"data": data}
在此示例中,我们有一个名为 fetch_data 的新函数,它使用 httpx 库执行异步 HTTP GET 请求。fetch_data 函数使用 async 关键字定义为协程。
在 get_data 终端节点中,我们使用 await 关键字调用 fetch_data 协程,以异步方式从外部 API 获取数据。get_data 函数的执行将暂停,直到收到来自 API 的响应。
这允许 FastAPI 同时处理多个请求。当一个请求等待来自外部 API 的响应时,FastAPI 可以处理其他请求,使应用程序更加高效和响应迅速。
使用 Fast API 设置和执行最基本的路由
- 首先创建目录并在目录内导航,然后运行此命令。
python -m venv venv
2. 然后激活环境。这两个步骤主要是为了在隔离环境中进行此开发。
C:\<目录名称>\venv\Scripts>activate.bat
3. 然后在其中安装带有依赖项的 FastAPI
pip install fastapi[全部]
4. 然后打开 VS code 或 Pycharm,将此代码保存在一个文件中并保存在创建的目录中
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
def root():
return {"message": "Hello World from FastAPI"}
5.转到命令提示符并导航到目录并点击此命令
uvicorn main:app — 重新加载
此命令是指:
- main:文件 main.py(Python “模块”)。
- app:在 main.py 中创建的对象,行 app = FastAPI()。
- — 重新加载:在代码更改后重新启动服务器。仅用于开发。
INFO: Will watch for changes in these directories: ['C:\\personalwork\\apitutorial\\app']
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO: Started reloader process [16600] using WatchFiles
INFO: Started server process [13332]
INFO: Waiting for application startup.
INFO: Application startup complete.
INFO: 127.0.0.1:64425 - "GET / HTTP/1.1" 200 OK
您可以打开浏览器并粘贴 URL,您可以看到 JSON 响应如下: