django自动生成接口文档

先pip安装coreapi包

pip install coreapi

小知识（这里不需要使用）：导出pip所有的包到txt文件中

pip freeze > requestment.txt

这个是从文件里用pip安装所有的包

pip install -r requestment.txt

配置，在urls.py

导包，然后在urlpatterns加入，取名称

from rest_framework.documentation import include_docs_urls

urlpatterns = [
    url(r'docs/', include_docs_urls(title='接口文档'))
]

在对应的serializers.py文件设置备注

在需要写备注的序列化器的class Meta里写额外备注：

class Meta:
        # 补充说明
        extra_kwargs = {
            'username': {
                'help_text': '4-20位,只能是大小写字母数字和下划线',
                'min_length': 4,
                'max_length': 20,
                'error_messages': {
                    'min_length': '4个字符',
                    'max_length': '20个字符'
                }
            },
            'password': {
                # 这是备注
                'help_text': '这是密码,6-20位'
            }
        }

打开接口文档网页：