Vue+Django2.0.6 学习笔记 9.1 drf的api文档自动生成和功能详解

drf是自带文档生成功能的 只需要在urls.py中添加以下路由即可

# ------------------------------>文档页面标题
path('docs/', include_docs_urls(title='慕学生鲜')),

这里可以看到整个界面都是非常侵袭和完善的。

左边是各个请求的类和相应的请求方法对应的参数。 

interact按钮是用于请求测试。再右边是示例代码

左下角是各语言的切换

这里的请求描述

来源于

class CategoryViewset(mixins.ListModelMixin, mixins.RetrieveModelMixin, viewsets.GenericViewSet):
    """
    list:
        商品分类列表数据
    retrieve:
        获取商品分类详情
    """

请求中涉及到model的字段 

在model中设置

class UserFav(models.Model):
    """
    用户收藏
    """
    user = models.ForeignKey(User, verbose_name=u'用户', on_delete=models.CASCADE)
# 这里 help_text
    goods = models.ForeignKey(Goods, verbose_name=u'商品', on_delete=models.CASCADE, help_text=u'商品ID')
    add_time = models.DateTimeField(default=datetime.now, verbose_name=u'添加时间')

也可以在serializer.py中定义的字段

    username = serializers.CharField(label="用户名", help_text="用户名",
                                    required=True, allow_blank=False,
                                     validators=[UniqueValidator(queryset=User.objects.all(), message="用戶已存在")])

也可以在filters.py中定义描述

class GoodsFilter(django_filters.rest_framework.FilterSet):
    """
    商品的过滤类
    """
# 这里 help_text
    pricemin = django_filters.NumberFilter(field_name='shop_price', lookup_expr='gte', help_text="最低价格")
    pricemax = django_filters.NumberFilter(field_name='shop_price', lookup_expr='lte')

有些页面请求需要通过登陆验证。所以左下角的Authentication可以先登录后再测试各个请求接口

 

上面输入JWT

下面输入jwt的token码 登陆即可

这个文档自动生成溜的一逼。 

官方文档：

https://www.django-rest-framework.org/topics/documenting-your-api/#documenting-your-api

完结