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

- 日理万妓 2022-10-02 10:56 128阅读 0赞

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

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NvdWx3eWI_size_16_color_FFFFFF_t_70][]

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

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

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

左下角是各语言的切换

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NvdWx3eWI_size_16_color_FFFFFF_t_70 1][]

这里的请求描述

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NvdWx3eWI_size_16_color_FFFFFF_t_70 2][]

来源于

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

请求中涉及到model的字段

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NvdWx3eWI_size_16_color_FFFFFF_t_70 3][]

在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中定义的字段

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NvdWx3eWI_size_16_color_FFFFFF_t_70 4][]

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

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NvdWx3eWI_size_16_color_FFFFFF_t_70 5][]

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可以先登录后再测试各个请求接口

![20190618132127988.png][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NvdWx3eWI_size_16_color_FFFFFF_t_70 6][]

上面输入JWT

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

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

官方文档：

[https://www.django-rest-framework.org/topics/documenting-your-api/\#documenting-your-api][https_www.django-rest-framework.org_topics_documenting-your-api_documenting-your-api]

完结

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NvdWx3eWI_size_16_color_FFFFFF_t_70]: /images/20220112/ce44546051ea4999acbc3e80dec328f5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NvdWx3eWI_size_16_color_FFFFFF_t_70 1]: /images/20220112/914656ba73d946bc99d2bc9966a1a853.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NvdWx3eWI_size_16_color_FFFFFF_t_70 2]: /images/20220112/ec6f13c3c99d4864a8c4050e7d707575.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NvdWx3eWI_size_16_color_FFFFFF_t_70 3]: /images/20220112/94c33d9eabeb444fadeeb8ec66caabbe.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NvdWx3eWI_size_16_color_FFFFFF_t_70 4]: /images/20220112/d9fd5ee61b8440a98ab6c398217ddfa9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NvdWx3eWI_size_16_color_FFFFFF_t_70 5]: /images/20220112/e226ca9fd15f43359fff7d68c00031fd.png
[20190618132127988.png]: /images/20220112/36ec18c21df94c0ca9928b1ac5b90b49.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NvdWx3eWI_size_16_color_FFFFFF_t_70 6]: /images/20220112/92793734ced1403589fa2fa90ecbfe1c.png
[https_www.django-rest-framework.org_topics_documenting-your-api_documenting-your-api]: https://www.django-rest-framework.org/topics/documenting-your-api/#documenting-your-api