我有大量用 django-rest-framework 编写的 API 端点,并且它不断增加和更新。如何创建和维护应该是最新的 API 文档?
我现在的版本是
- 创建
swagger.yaml文件,并在每次任何端点更改时以某种方式自动生成。 - 然后使用此文件作为 readme.io、ReDoc 或其他替代方案的输入,为外部人员提供可视化。
如果您对此或任何类似解决方案有经验,请分享,我非常感谢!
请您参考如下方法:
是的,你可以看看 drf-yasg:
快速入门展示了如何创建 4 个端点,包括一个输出 swagger.yaml 文件的端点。包含 drf-yasg 后,您可以导航至:
http://localhost:8000/swagger.yaml
这将允许您将 swagger 文档保存到磁盘。
