让程序自动为你的API编写文档

程序员最怕的事是什么，那就是写文档。

其实程序员们都知道文档的重要性，都想好好写写自己代码相关的文档，但是没有太多写文档的时间。需求太多，变化太快，程序员不是在写代码，就是在改代码。早上写好的代码，中午可能又改了一版，就算有文档，也不知道滞后了多少个版本。

因此，在夜深人静的时候，程序员开始反思，有没有程序可以自动根据我的注释，函数功能等为我自动生成接口文档呢？

网上搜索了下，还真有人正在完善一个自动文档的项目，人家是牛人完全从 0 开始的，我非常敬佩。

通过搜索还发现了 django-rest-framework 可以自动为你的 api 生成文档，这里也有些缺点，比如必须使用 django-rest-framework 来生成 api。只需要稍微的配置，就可以让 django-rest-framework 自动生成 api 的文档了。

先看下效果图：

class GroupViewSet(viewsets.ModelViewSet):
"""
API endpoint that allows groups to be viewed or edited.
"""
queryset = Group.objects.all()
serializer_class = GroupSerialize

本节先到这里，下见详细介绍如何使用。