FastAPI 更换 docs文档风格

一种常见的需求是更换FastAPI生成的文档中的默认样式和布局。FastAPI的文档生成是基于Swagger UI实现的,它使用了一套默认的样式和布局。要更换这些默认的样式和布局,我们需要对FastAPI的文档生成进行定制。

首先,我们需要安装必要的依赖。在项目的根目录下,打开命令行并运行以下命令:

pip install fastapi

接下来,我们需要创建一个templates目录,用于存放我们自定义的模板文件。在templates目录下创建一个index.html文件,这个文件将作为我们生成的文档的主页。在index.html中,我们可以编写自定义的HTML和CSS代码,来更换默认的样式和布局。例如,我们可以修改标题的样式、添加自定义的导航栏等等。

在项目的主文件中,我们需要引入fastapifastapi.staticfiles模块,然后修改app实例的一些配置。我们可以添加一个静态文件目录,将templates目录的路径作为参数传递给StaticFiles类的构造函数。这样,FastAPI就会在静态文件目录中查找我们自定义的模板文件。

接下来,我们需要修改app实例的docs_urlredoc_url属性,将它们的值改为我们自定义的路径。例如,我们可以将docs_url设置为/custom-docs,将redoc_url设置为/custom-redoc。这样,生成的文档就可以通过这些路径访问。

最后,我们需要重新运行项目,使更改生效。在命令行中输入以下命令:

uvicorn main:app --reload

现在,我们可以通过访问http://localhost:8000/custom-docs来查看我们自定义的文档页面了。

总结来说,要将FastAPI生成的文档更换为自定义的样式和布局,我们需要创建一个templates目录,编写一个index.html文件作为自定义的文档主页,并修改app实例的一些配置。然后重新运行项目,即可查看自定义的文档页面。这样,我们就能够根据自己的需求定制FastAPI生成的API文档了。

  • 8
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Loading_create

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值