精华内容
下载资源
问答
  • django自动生成接口文档

    千次阅读 2019-06-18 10:31:42
    django自动生成接口文档先pip安装coreapi包导出pip所有的包到txt文件中配置,在urls.py在serializers.py文件设置备注 先pip安装coreapi包 pip install coreapi 导出pip所有的包到txt文件中 pip freeze > ...

    先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位'
                }
            }
    

    打开接口文档网页:
    在这里插入图片描述

    展开全文
  • python django自动生成接口文档

    千次阅读 2019-06-18 14:51:47
    1.安装coreapi包 pip install coreapi 2.配置接口的路径(在同名文件夹的url路径下配置) from rest_framework.documentation import ... url(r'^docs/',include_docs_urls(title='接口文档')), ] 3.在网页输入UR...

    1.安装coreapi包

    pip install coreapi
    

    2.配置接口的路径(在同名文件夹的url路径下配置)

    from rest_framework.documentation import include_docs_urls
    urlpatterns = [
        url(r'^docs/',include_docs_urls(title='接口文档')),
    ]
    

    3.在网页输入URL网址
    在这里插入图片描述

    展开全文
  • 今天小编就为大家分享一篇Django 自动生成api接口文档教程,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
  • Django 自动生成api接口文档

    千次阅读 2019-06-18 19:21:21
    Django 自动生成api接口文档安装第三方包配置接口路径在serializers.py文件设置备注 安装第三方包 pip install coreapi 配置接口路径 from rest_framework.documentation import include_docs_urls urlpatterns = ...

    安装第三方包

    pip install coreapi
    

    配置接口路径

    from rest_framework.documentation import include_docs_urls
    
    urlpatterns = [
        url(r'^admin/', admin.site.urls),
        url(r'docs/', include_docs_urls(title='接口文档')),  # 接口路径 
    ]
    

    在serializers.py文件设置备注

    在序列化器的class Meta 里面的extra_kwargs里面添加额外备注:

    class Meta:
            model = models.User
            fields = ('id','username','email','password','phone','pwdagain','messagecode','ischecked','token',)
    
            # 补充说明
            extra_kwargs= {
                'username':{
                    'min_length': 6,
                    'max_length': 12,
                    'error_messages':{
                        'min_length': '6个字符',
                        'max_length': '12个字符',
                    },
                },
                'password': {
                    'help_text': '密码6-8位',
                }
            }
    
    

    用浏览器打开api接口文档页面:

    在这里插入图片描述
    通过上面代码help_text补充说明后的接口文档部分图:
    在这里插入图片描述

    展开全文
  • 自动生成接口文档 REST framework可以自动帮助我们生成接口文档。 接口文档以网页的方式呈现。 自动接口文档能生成的是继承自APIView及其子类的视图。 1、安装依赖 REST framewrok生成接口文档需要coreapi库的支持。...

    自动生成接口文档
    REST framework可以自动帮助我们生成接口文档。

    接口文档以网页的方式呈现。

    自动接口文档能生成的是继承自APIView及其子类的视图。

    1、安装依赖
    REST framewrok生成接口文档需要coreapi库的支持。

    pip install coreapi
    

    2、设置接口文档访问路径
    在总路由中添加接口文档路径。

    文档路由对应的视图配置为rest_framework.documentation.include_docs_urls,

    参数title为接口文档网站的标题。

    from rest_framework.documentation import include_docs_urls
    
    urlpatterns = [
        ...
        url(r'^docs/', include_docs_urls(title='My API title'))
    ]
    

    3、文档描述说明的定义位置
    1) 单一方法的视图,可直接使用类视图的文档字符串,如

    class BookListView(generics.ListAPIView):
        """
        返回所有图书信息.
        """
    

    2)包含多个方法的视图,在类视图的文档字符串中,分开方法定义,如

    class BookListCreateView(generics.ListCreateAPIView):
        """
        get:
        返回所有图书信息.
    
        post:
        新建图书.
        """
    

    3)对于视图集ViewSet,仍在类视图的文档字符串中封开定义,但是应使用action名称区分,如

    class BookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):
        """
        list:
        返回图书列表数据
    
        retrieve:
        返回图书详情数据
    
        latest:
        返回最新的图书数据
    
        read:
        修改图书的阅读量
        """
    
    1. 访问接口文档网页
      浏览器访问 127.0.0.1:8000/docs/,即可看到自动生成的接口文档。

    接口文档网页

    在这里插入图片描述

    两点说明:
    1) 视图集ViewSet中的retrieve名称,在接口文档网站中叫做read

    2)参数的Description需要在模型类或序列化器类的字段中以help_text选项定义,如:

    class BookInfo(models.Model):
        ...
        bread = models.IntegerField(default=0, verbose_name='阅读量', help_text='阅读量')
        ...
    

    class BookReadSerializer(serializers.ModelSerializer):
        class Meta:
            model = BookInfo
            fields = ('bread', )
            extra_kwargs = {
                'bread': {
                    'required': True,
                    'help_text': '阅读量'
                }
            }
    
    展开全文
  • 自动生成接口文档 REST framework可以自动帮助我们生成接口文档。 接口文档以网页的方式呈现。 自动接口文档能生成的是继承自APIView及其子类的视图。 1. 安装依赖 REST framewrok生成接口文档需要coreapi库的支持。...
  • REST framework可以自动帮助我们生成接口文档 接口文档以网页的方式呈现 自动接口文档能生成的是继承自APIView及其子类的视图。 1. 安装依赖 REST framewrok生成接口文档需要coreapi库的支持 pip install coreapi 2....
  • REST framework可以自动帮助我们生成接口文档。 接口文档以网页的方式呈现。 自动接口文档能生成的是继承自APIView及其子类的视图。 1. 安装依赖 REST framewrok生成接口文档需要coreapi库的支持。 pip install core...

空空如也

空空如也

1 2 3 4 5 ... 7
收藏数 122
精华内容 48
热门标签
关键字:

django自动生成接口文档