FASTAPI系列 02-简单入门
实现一个简单的例子
编写一个简单的get请求,请求/first路径,返回一个接口报文 {“message”:“Hello,Word!”}
创建一个main.py 文件,代码如下:
from fastapi import FastAPI
# 导入FastAPI模块并创建一个FastAPI实例
app = FastAPI()
# 使用装饰器@app.get("/")定义一个GET请求处理函数(endpoint)
# 当用户访问应用的根路径 "/" 时,root函数会被调用
@app.get("/first")
async def root():
# 函数返回一个字典,内容为 {"message": "Hello World"}
# 这个字典会被自动转换成JSON格式返回给客户端
return {"message": "Hello World"}
if __name__ == "__main__":
import uvicorn
uvicorn.run(app, host="0.0.0.0", port=8000)
执行main函数方法,启动服务:
uvicorn.run(app, host=“0.0.0.0”, port=8000) 是在使用 Uvicorn 服务器启动一个 Web 应用程序时的命令。Uvicorn 是一个高性能 ASGI(Asynchronous Server Gateway Interface)服务器,特别适合服务于基于 Python 的异步框架,比如 FastAPI;
-
uvicorn.run: 这是 Uvicorn 模块提供的一个函数,它负责启动 Web 服务器并运行指定的应用程序实例。
-
app: 这是您要运行的应用程序对象,通常是 FastAPI 或 Starlette 创建的一个应用实例。这个对象包含了您的路由、视图函数等构成 Web 服务的所有内容。
-
host=“0.0.0.0”: 这个参数指定了服务器监听的主机地址。在这里,设置为 “0.0.0.0” 表示服务器将在所有可用网络接口上监听,包括本地回环接口(localhost)和任何公开的网络接口,这意味着其他设备可以通过该服务器所在的机器的 IP 地址访问此服务。
-
port=8000: 这是指定服务器监听的端口号,这里是 8000。通过这个端口,客户端可以通过 HTTP 协议与服务器进行通信。例如,要访问运行在此服务器上的应用,用户可以在浏览器中输入 http://your_server_ip:8000。
使用浏览器访问:http://127.0.0.1:8000/first, 显示返回报文
FASTAPI 的swagger 文档,交互式API
使用swagger调用接口
持续更新,请关注公众号
、