用YAML生成Swagger格式的API Documentation

发布网友发布时间：2022-12-26 15:35

共1个回答

热心网友时间：2023-10-16 03:51

在工作当中，会遇到需要写API文档的情况。最开始，在网上搜现成的django-rest-swagger，用了之后发现，不是很好用，没办法一次成型的解决问题。后来，就直接本办法，把yaml转化成swagger的html，就是套django模板啦（render）。yaml语法和json宗旨是差不多的，都是list和dict的结合。swagger就是一种内容特定化的yaml文件。

YAML的view如下（一个view函数）：

模板如下（html模板，替换字符串，记住要加 ‘|safe’）：

YAML文件：

声明：本网页内容为用户发布，旨在传播知识，不代表本网认同其观点，若有侵权等问题请及时与本网联系，我们将在第一时间删除处理。E-MAIL:11247931@qq.com