DRF生成器-drf-generators
关于
📐 为您的Django Rest Framework应用程序生成视图,序列化程序和Urls
编写API可能是无聊且重复的工作。不要在Django Rest Framework中编写另一个CRUDdy视图。使用DRF生成器,一个简单的命令将为Django Rest Framework应用程序生成所有视图,序列化程序,甚至Urls!
这并不是要为您提供生产质量的API。它旨在快速启动您的开发,并避免您为每个模型一遍又一遍地编写相同的代码。
安装
$ pip install django
$ pip install djangorestframework
$ pip install drf-generators
要使用DRF生成器,请将其添加到您的INSTALLED_APPS。
INSTALLED_APPS =(
...
' rest_framework ',
'drf_generators',
...
)
注意:为了使用APIView类,必须设置其余框架DEFAULT_PAGINATION_CLASS和PAGE_SIZE。
REST_FRAMEWORK = {
'DEFAULT_PAGINATION_CLASS':'rest_framework.pagination.PageNumberPagination',
'PAGE_SIZE':15
}
用法
先新建项目
$ python3 manage.py startapp test_api
进行数据表定义,并且进行数据迁移生成相关的数据表
要使用生成器,请运行以下命令,其中app
要为其生成API的应用程序在哪里。
$ python manage.py generate 生成{app} {options}
选项 | 行动 |
---|---|
--serializers |
仅为您的应用生成序列化器。 |
--views |
仅为您的应用生成视图。 |
--urls |
仅为您的应用生成网址。 |
--force |
覆盖现有文件而没有警告提示。 |
-f , --format |
生成视图和URL时使用的格式。有效选项:viewset ,apiview ,function ,modelviewset 。默认值:viewset 。 |
-d , --depth |
相关模型的序列化深度。默认值:0 |
示例:api
使用函数样式视图为应用程序生成所有内容,覆盖现有文件,序列化深度为2。
$ python manage.py生成api --format函数 --force --depth = 2