将视图、序列化程序和路由器定义为pumpwood格式
pumpwood-viewutils的Python项目详细描述
扩展django和rest框架异常,以便更好地详细描述模型未指定,并允许对错误数据进行序列化,以便于前端调试。
快速启动
将“pumpwood\u viewutils”添加到Django安装的应用程序设置中,如下所示:
INSTALLED_APPS = [ ... 'pumpwood_viewutils', ]
说明
Pumpwood视图公开的每个模型都有九个基本端点通过Pumpwood路由器公开。
- 列表,用作post:{slugfied model\u name}/list
- list_不带pag,用作post:{slugfied model_name}/list不带pag
- 检索,作为post:{slugfied model_name}/retrieve/(?pk)
- 删除,用作删除:{slugfied model\u name}/retrieve/(?pk)
- 保存,作为post,放置:{slugfied model}/save/
- 列出动作,用作get{slugfied model}/actions/
- execute_action,作为post{slugfied model_name}/execute_action/(?pk)
- 列表搜索选项,用作get{slugfied model}/选项
- 列表选项,用作post{slugfied model}/options
列表
根据作为msg body传递的筛选器dict返回对象列表。列表以最大值重写 rest_framework上定义的长度[['paginate_by']]
列表中没有pag
根据作为msg body传递的filter dict返回对象列表,但没有长度限制
检索
将对象作为字典返回,并由检索序列化程序序列化。通常,当一个对象被检索时,它有更多的 比上市时的信息。
删除
删除数据元素对象。出于安全原因,已映射URL,但未实现用于删除对象的代码(这会引发错误,必须重写)。
保存
根据msg body dictionary保存并更新对象。如果msg body有一个主键,则具有此主键的对象将被更新,否则将创建它
列出动作
列出用@rest_函数包装器标记的类函数。返回一个包含操作路径、简短描述和 在前端使用的图标和必要的参数,可选参数以及函数将返回什么。
执行操作
如果pk已填充,则对对象或类方法执行操作。返回包含结果、操作名称、操作中使用的参数和对象的字典 在其上执行操作。
列表搜索选项
返回下拉列表中的用户选项和搜索对象时使用的其他筛选器。
列表选项
根据对象的包裹胶片列出对象创建的选项。
这个项目处于测试阶段,请小心使用。