没有项目描述
django-api-toolkit的Python项目详细描述
内容
Instalation
pip install django-api-toolkit
Get started
首先，您需要初始化您的项目
project_init <path to project>
对于现有项目，您应该生成^ {STR 1 } $Env文件
env_generator <path to project>
此脚本生成运行项目所需的基本变量。也可以在env文件中添加自变量 您还应该更改manage.py。将apimanager添加到文件中。E.Q.
#!/usr/bin/env pythonimportsysfromapi_tools.utilsimportAPIManagerif__name__=="__main__":er=APIManager(__file__,'cfg.settings')# path to user project settingser.set_app_dir('apps')# directory for user project applicationser.apply()# apply settingsfromdjango.core.managementimportexecute_from_command_lineexecute_from_command_line(sys.argv)
Usage
Structure
├── apps # dir for your apps ├── cfg # dir for diferent project configurations │ ├── settings.py # user project settings │ └── wsgi.py └── manage.py
Settings
- 公共应用程序-django公共应用程序
- 额外的应用程序-应用程序应在普通应用程序之前安装
- 项目应用程序-您的项目应用程序
您还可以覆盖其他标准的django设置键并添加自己的变量
Models
所有项目模型都应该继承restmodel（这个standart django抽象模型，您可以使用所有功能 其中）
fromapi_tools.modelsimportRestModelclassMyModel(RestModel):...
Advanced
restmodel有子类rest。此子类具有用于控制rest模型的属性。restmodel也有 这些控件的类方法。
RestModel overwrites
RestModel.Rest
| queryset: | defines queryset as lambda of ^{ |
|---|---|
| fields: | list of allowed fields of model |
| name: | name of viewset |
| route: | route of endpoint |
RestModel._rest_serializer
为模型的视图集定义序列化程序
RestModel._rest_queryset
为视图集定义queryset
RestModel._rest_endpoint
为模型设置端点
欢迎加入QQ群-->： 979659372
