python - Django Rest Framework 是否有第三方应用程序可以自动生成 swagger.yaml 文件？

Question

我有大量的 API 端点被写入django-rest-framework并且它不断增加和更新。如何创建和维护应该是最新的 API 文档？

我目前的版本是

1. 创建swagger.yaml文件并以某种方式在每次任何端点更改时自动生成。
2. 然后将此文件用作 readme.io、ReDoc 或其他替代方案的输入，以向外部人员提供可视化。

如果您对此或任何类似解决方案有经验，请分享我非常感谢！

Answer 1

是的，你可以看看 drf-yasg：

drf-yasg 文档

快速入门展示了如何创建 4 个端点，包括一个输出 swagger.yaml 文件的端点。包含 drf-yasg 后，您可以导航到：

http://localhost:8000/swagger.yaml

然后，您可以将 swagger 文档保存到磁盘。