FastAPI 自动生成的docs文档没法使用

我不是女神ヾ 2023-03-01 10:09 20阅读 0赞

FastAPI 自动生成的docs文档没法使用，当展开路径时候一直在转圈，具体就是这样

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N0eTk0NQ_size_16_color_FFFFFF_t_70]

这个是由于swagger-ui 3.30.1 中的bug导致，具体bug可以看[这里][Link 1]

我们可以通过在FastAPI中指定低版本的swagger-ui 来解决这个问题，主要方法是在main.py的文件中加上如下代码：

from fastapi import applications
    from fastapi.openapi.docs import get_swagger_ui_html
    
    
    def swagger_monkey_patch(*args, **kwargs):
        """
        Wrap the function which is generating the HTML for the /docs endpoint and 
        overwrite the default values for the swagger js and css.
        """
        return get_swagger_ui_html(
            *args, **kwargs,
            swagger_js_url="https://cdn.jsdelivr.net/npm/swagger-ui-dist@3.29/swagger-ui-bundle.js",
            swagger_css_url="https://cdn.jsdelivr.net/npm/swagger-ui-dist@3.29/swagger-ui.css")
    
    
    # Actual monkey patch
    applications.get_swagger_ui_html = swagger_monkey_patch
    
    
    # Your normal code ...
    app = FastAPI()

# 参考 #

https://github.com/tiangolo/fastapi/issues/1762

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N0eTk0NQ_size_16_color_FFFFFF_t_70]: /images/20230209/29c720425db740a981abe25d7a8246a0.png
[Link 1]: https://github.com/swagger-api/swagger-ui/issues/6249

发表评论取消回复

表情：

评论列表（有 0 条评论，20人围观）

还没有评论，来说两句吧...

相关阅读

相关配置 Swagger 文档的自动生成

Swagger Swagger 是一个开源工具。它围绕帮助开发人员设计、构建、记录和使用 RESTful API 的 OpenAPI 规范构建。它是 RESTful We

小咪咪/ 2023年10月01日 18:01/ 0 赞/ 48 阅读

相关 Java使用FreeMarker自动生成Word文档

背景：根据模板填充导出word 一.添加依赖 1 <dependency> 2 <groupId>org.freemarker</groupI

Bertha 。/ 2023年10月01日 11:42/ 0 赞/ 64 阅读

相关 FastAPI 自动生成的docs文档没法使用

FastAPI 自动生成的docs文档没法使用，当展开路径时候一直在转圈，具体就是这样 ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGV

我不是女神ヾ/ 2023年03月01日 10:09/ 0 赞/ 21 阅读

相关接口文档生成工具smart-doc

官网 https://gitee.com/smart-doc-team/smart-doc 简介 smart-doc是一款同时支持JAVA REST API和Ap

末蓝、/ 2022年09月10日 12:13/ 0 赞/ 365 阅读

相关根据excel或者doc模板生成excel和doc文档

对于任何复杂度的excel或doc文档，我们如果需要根据doc模板动态使用程序填充其中文本内容，可以采取如下的方式进行：第一：打开excel或word文档，另存为xml格式

谁践踏了优雅/ 2022年08月26日 04:44/ 0 赞/ 261 阅读

相关使用swagger作为restful api的doc文档生成

初衷记得以前写接口，写完后会整理一份API接口文档，而文档的格式如果没有具体要求的话，最终展示的文档则完全决定于开发者的心情。也许多点，也许少点。甚至，接口总是需要适应

曾经终败给现在/ 2022年07月16日 07:45/ 0 赞/ 290 阅读

相关 JAVA通过模板生成DOC文档

将word文档另存为xml文件 ![0_1329123601TArY.gif][] 接下来,上面写的拼音就起到作用了. 打开xml文件.搜索要替换的内容. 改为 $\

Bertha 。/ 2022年07月14日 07:49/ 0 赞/ 286 阅读

相关使用swagger作为restful api的doc文档生成

本文作者：[@Ryan Miao][Ryan Miao] 本文链接：[http://www.cnblogs.com/woshimrf/p/swagger.html]

落日映苍穹つ/ 2022年05月24日 00:58/ 0 赞/ 299 阅读

相关使用Swagger自动生成文档

> swagger 自动生成html文档 > 使用 wireMock快速伪造Restful服务 pom.xml <dependency> <g

以你之姓@/ 2022年05月10日 06:00/ 0 赞/ 407 阅读

相关 shoDoc自动生成API文档使用说明

shoDoc使用说明操作系统windos,其他操作系统见官网介绍自动生成API 主要步骤： 1. 安装git for windows :[git][

冷不防/ 2021年07月26日 23:40/ 0 赞/ 717 阅读