在Swagger文档中添加图片

Question

我正在使用Python FastAPI编写一些Rest API。有一个要求是在Swagger - OpenAPI文档中添加大量自定义部分。这包括每个API的联系信息、作者信息、显示数据模型的图片、数据库字段等。

有没有办法利用Fast API内置的OpenAPI功能来完成所有这些任务？我知道可以托管自己的自定义JSON文件，但我不知道如何将图像添加到Swagger JSON文件中。也不知道如何添加相应的自定义字段。

是否有任何模板可用于托管Swagger文档的HTML版本？

任何帮助将不胜感激。

- searcot jabali

---

请参考如何格式化OpenAPI描述 - 您可以使用Markdown格式，包括用于图像的![alt text](https://path/to/image.png)语法。 - Helen

Answer 1

ReDoc在其description标签中使用标准的HTML标记。

description: |
  An example image
  <img alt="Example" src="../images/example.png" />

- Software2