在 FastAPI 文档描述中添加美人鱼图答案

【问题标题】：Add mermaid diagram in FastAPI docs description在 FastAPI 文档描述中添加美人鱼图
【发布时间】：2022-09-23 02:55:22
【问题描述】：

我想在 FastAPI 的文档描述中添加美人鱼图：

from fastapi import FastAPI
description = \"\"\"
    <div class=\"mermaid\">
            graph TD 
            A[Client] --> B[Load Balancer] 
            B --> C[Server01] 
            B --> D[Server02]
        </div>
    <script>
            mermaid.initialize({ startOnLoad: true });
        </script>
        <script src=\"https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js\"></script>
    \"\"\"
app = FastAPI(description=description)

但似乎 fastapi 删除了脚本标签和“美人鱼”类。如何轻松添加美人鱼图？我不想使用图像。

谢谢

您是否尝试过使用 Mermaid 单独创建图表，然后使用生成的纯 HTML 进行 FastAPI 描述？

标签： python fastapi mermaid

【解决方案1】：

出于安全目的，swagger markdown 引擎对 HTML 标记进行了清理。不幸的是，我认为这种功能很可能是设计不允许的。

【讨论】：