快速REST API创建
django-startapi的Python项目详细描述
Django启动API
快速REST API创建。在
快速准备使用基于Django和DRF的restapi,创建配置文件, 启动“startapi”,您将获得:
- 创建标准Django项目
- 已创建所有应用程序
对于每个应用程序:
- 已创建和移植的模型
- 对于每个型号:
- 完整的工作api(GET、POST、PUT PATCH、DELETE)(参考: https://www.django-rest-framework.org/api-guide/routers/#simplerouter)
- ModelViewSet已创建
- 已创建ModelSerializer
- 使用DefaultRouter注册的URL
- 注册模型管理员
安装
pip install django_startapi
快速启动
- 创建您的配置.yaml在
- 运行“startapi”
用法
该软件旨在创建一个初始的完整工作REST API, 基于Django和Django Rest框架。使用配置文件中的模型设计应用程序 运行django_nustartapi。在
- 创建一个名为'配置.yaml'
- 跑startapi
- 可选:python管理.py创建超级用户
- Python管理.py运行服务器并转到http://127.0.0.1:8000/api/
配置文件
- 添加用于django admin stratproject的项目名称
- 用模型定义应用程序,模型字段是Django字段
Note: Write related model name as string or put related models before relation to avoid "NameError: name 'YourModel' is not defined"
配置文件结构:
^{pr2}$配置文件示例
project: audiolibrary
apps:
band:
Musician:
name: CharField(max_length=40)
surname: CharField(max_length=40)
born_date: DateField(null=True)
Band:
name: CharField(max_length=100)
author: ManyToManyField('Musician')
album:
Genre:
name: CharField(max_length=100)
Label:
name: CharField(max_length=100)
Album:
name: CharField(max_length=120)
band: ForeignKey('band.Band', on_delete=models.DO_NOTHING)
label: ForeignKey('Label', on_delete=models.DO_NOTHING)
date: DateField(null=True)
- 项目
标签: