教程5-API接口文档和接口测试

配置

pip install coreapi
#安装依赖

from rest_framework.documentation import include_docs_urls

urlpatterns = [
    ....

    path('docs/',include_docs_urls('xADM api docs'))
]
#配置url

class CourseViewSet(viewsets.ModelViewSet):
    """
    retrieve:
        返回指定course信息
    list:
        返回course列表
    update:
        更新course信息
    destroy:
        删除course记录
    create:
        创建course记录
    partial_update:
        更新部分字段
    """
#在view中的资源类下，说明注释信息

　　

class Course(models.Model):
    name = models.CharField(max_length=64,verbose_name='课程名称',help_text='课程名称')
    ...
#在model或者serializer中添加help_text字段。它会显示在api文档的字段描述信息中