FastApi教程|应用配置

发表时间:2020-03-09

您可以在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

默认情况下,OpenAPI模式在提供 /openapi.json

但是您可以使用参数进行配置 openapi_url

例如,将其设置为 /api/v1/openapi.json

from fastapi import FastAPI

app = FastAPI(openapi_url="/api/v1/openapi.json")


@app.get("/items/")
async def read_items():
    return [{"name": "Foo"}]

如果要完全禁用OpenAPI架构,可以设置 openapi_url=None

文件网址

您可以配置包括的两个文档用户界面:

  • Swagger UI :在担任 /docs
    • 您可以使用参数设置其URL docs_url
    • 您可以通过设置禁用它 docs_url=None
  • ReDoc:在送达 /redoc
    • 您可以使用参数设置其URL redoc_url
    • 您可以通过设置禁用它 redoc_url=None

例如,要将Swagger UI设置为在上使用 /documentation 并禁用ReDoc:

from fastapi import FastAPI

app = FastAPI(docs_url="/documentation", redoc_url=None)


@app.get("/items/")
async def read_items():
    return [{"name": "Foo"}]

文章来源互联网,如有侵权,请联系管理员删除。邮箱:417803890@qq.com / QQ:417803890

微配音

Python Free

邮箱:417803890@qq.com
QQ:417803890

皖ICP备19001818号-4
© 2019 copyright www.pythonf.cn - All rights reserved

微信扫一扫关注公众号:

联系方式

Python Free