Python使用Fastapi开发的步骤-创新互联
这篇文章将为大家详细讲解有关Python使用Fastapi开发的步骤,小编觉得挺实用的,因此分享给大家做个参考,希望大家阅读完这篇文章后可以有所收获。
创新互联建站是专业的柳江网站建设公司,柳江接单;提供成都网站建设、成都网站制作,网页设计,网站设计,建网站,PHP网站建设等专业做网站服务;采用PHP框架,可快速的进行柳江网站开发网页制作和功能扩展;专业做搜索引擎喜爱的网站,专业的做网站团队,希望更多企业前来合作!Fastapi是一个基于python的框架,该框架鼓励使用Pydantic和OpenAPI(以前称为Swagger)进行文档编制,使用Docker进行快速开发和部署以及基于Starlette框架进行的简单测试。
它提供了许多好处,例如自动OpenAPI验证和文档编制,而无需添加不必要的膨胀。我认为,在不提供任何内置功能与提供太多内置功能之间取得很好的平衡。
安装安装 fastapi 和 ASGI 服务器(例如uvicorn):
确保您使用的是Python 3.6.7+ 如果 pip
和python
给您python 2版本,则可能必须使用 pip3
和 python3
。另外,请查看我关于python入门的文章。
pip install fastapi uvicorn
并在main.py
文件中添加旧的“ hello world”:
from fastapi import FastAPI app = FastAPI() @app.get("/") def home(): return {"Hello": "World"}运行开发
然后运行以进行开发,可以运行uvicorn main:app --reload
这就是简单服务器要做的全部!现在您可以检查 //localhost:8000/ 以查看“主页”。而且,如您所见,JSON响应“正常工作”!您还可以通过 //localhost:8000/docs 免费获得Swagger UI。
验证如前所述,很容易验证数据(并为接受的数据格式生成Swagger文档)。只需从fastapi添加Query
导入,然后使用它来强制验证:
from fastapi import FastAPI, Query @app.get('/user') async def user( *, user_id: int = Query(..., title="The ID of the user to get", gt=0) ): return { 'user_id': user_id }
第一个参数...
是默认值,如果用户不提供值则提供该默认值。如果设置为None
,则没有默认值,并且该参数是可选的。为了没有默认值并且该参数是强制性的,请使用Ellipsis ,或...
代替。
如果运行此代码,则会在swagger UI上自动看到更新:
Swagger UI允许您查看新的/ user路由并使用特定的用户ID进行请求
如果您输入任何用户ID,您会看到它会自动为您执行请求,例如 //localhost:8000/user?user_id=1。在页面中,您只能看到回显了用户ID!
如果要改为使用路径参数(以使其为 /user/1
,则只需输入并使用Path
而不是Query
。也可以结合两者
如果您有POST
路由,则只需定义输入即可
@app.post('/user/update') async def update_user( *, user_id: int, really_update: int = Query(...) ): pass
在这种情况下,您可以看到user_id
仅被定义为一个没有Query
或Path
的整数;这意味着它将在POST请求正文中。如果您接受更复杂的数据结构,例如JSON数据,则应研究请求模型。
您可以使用Pydantic模型记录并声明详细的请求和响应模型。这不仅可以让您拥有所有模型的自动OpenAPI文档,而且还可以验证请求模型和响应模型,以确保输入的任何POST数据都是正确的,并且返回的数据也符合该模型。
只需像这样声明模型:
from pydantic import BaseModel class User(BaseModel): id:: int name: str email: str
然后,如果您希望将用户模型作为输入,则可以执行以下操作:
async def update_user(*, user: User): pass
或者,如果您要将其用作输出:
@app.get('/user') async def user( *, user_id: int = Query(..., title="The ID of the user to get", gt=0), response_model=User ): my_user = get_user(user_id) return my_user路由和分解更大的API
您可以使用APIRouter
将api分解为路由。例如,我已经在我的 API 中找到了这个app / routers / v1 / __ init __。py
from fastapi import APIRouter from .user import router as user_router router = APIRouter() router.include_router( user_router, prefix='/user', tags=['users'], )
然后您可以在app / routers / v1 / user.py
中使用上面的用户代码-只需导入APIRouter
并使用@ router.get('/')< aaaa>
而不是 @ app.get('/ user')
。它会自动路由到 / user /
,因为该路由是相对于前缀的。
from fastapi import APIRouter router = APIRouter() @router.get('/') async def user( *, user_id: int = Query(..., title="The ID of the user to get", gt=0), response_model=User ): my_user = get_user(user_id) return my_user
最后,要在应用程序中使用所有v1
路由器,只需将main.py
编辑为:
from fastapi import FastAPI from app.routers import v1 app = FastAPI() app.include_router( v1.router, prefix="/api/v1" )
您可以通过这种方式随意链接路由器,从而允许您拆分大型应用程序并拥有版本化的API。
Dockerizing and DeployingFastapi 的作者使出乎意料的轻松之一就是 Dockerizing!默认的Dockerfile
是2行!
FROM tiangolo/uvicorn-gunicorn-fastapi:python3.7 COPY ./app /app
是否想通过自动重新加载进行 Dockerize 开发?这是我在撰写文件中使用的秘方:
version: "3" services: test-api: build: .. entrypoint: '/start-reload.sh' ports: - 8080:80 volumes: - ./:/app
这会将当前目录挂载为app
并将在任何更改时自动重新加载。您可能还想将app / app
用于更大的应用程序。
关于Python使用Fastapi开发的步骤就分享到这里了,希望以上内容可以对大家有一定的帮助,可以学到更多知识。如果觉得文章不错,可以把它分享出去让更多的人看到。
分享标题:Python使用Fastapi开发的步骤-创新互联
链接地址:http://pwwzsj.com/article/cdppdp.html