fastapi 大型应用_FastApi教程|应用配置

本文介绍了如何在FastAPI应用程序中配置标题、描述、版本以及OpenAPI和文档用户界面的相关设置,包括如何自定义OpenAPI URL、Swagger UI和ReDoc的URL,以及如何禁用这些功能。
摘要由CSDN通过智能技术生成

您可以在FastAPI应用程序中配置几件事。

标题,描述和版本

您可以设置:

标题:在OpenAPI和自动API文档用户界面中,用作API的标题/名称。

Description:OpenAPI和自动API文档UI中对API的描述。

版本:API的版本,例如

v2

2.5.0

例如,如果您具有应用程序的先前版本(也使用OpenAPI),则很有用。

要设置这些参数,使用这些参数

title

description

以及

version

from fastapi import FastAPI

app = FastAPI(

title="My Super Project",

description="This is a very fancy project, with auto docs for the API and everything",

version="2.5.0",

)

@app.get("/items/")

async def read_items():

return [{"name": "Foo"}]

使用此配置,自动API文档将如下所示:

OpenAPI的URL

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值