Django Rest Framework是否具有第三方应用程序来自动生成swagger.yaml文件?

时间:2018-07-14 21:08:56

标签: python django django-rest-framework swagger openapi-generator

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

我当前的版本是

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

如果您有关于此解决方案或任何类似解决方案的经验,请分享,我非常感谢!

1 个答案:

答案 0 :(得分:0)

是的,您可以看看drf-yasg:

drf-yasg docs

快速入门显示了如何创建4个端点,其中一个端点输出swagger.yaml文件。包含drf-yasg后,您可以导航到:

http://localhost:8000/swagger.yaml

这将使您可以将swagger文档保存到磁盘。