抱歉,你查看的文章不存在

在Django项目中规划和设计Restful风格的api接口

在上一篇文章中——【重新开始一个完整的Django Restful WEB项目】,我们开始了一个新的Django项目,并且设计和生成了项目的数据模型。有了数据模型,接下来,我们来规划设计一下我们这个项目的Restful接口。

之前我们一共生成了4个数据模型,分别是电影分类、电影、观众和观众评分。所以我们的Restful风格的api接口也是针对于这4个数据模型(资源)进行的设计。

一、需要使用到的HTTP请求方法

在本次项目中,我们使用以下HTTP请求方法来对资源(数据模型)进行操作:

  • GET请求方法:获取资源;
  • PUT请求方法:新增资源;
  • POST请求方法:更新整个资源;
  • PATCH请求方法:增量更新资源的某个字段;
  • DELETE请求方法:删除资源;
  • OPTION请求方法:获取服务器支持的方法;

二、数据模型的接口规划

电影分类模型的api接口规划

在电影分类模型中,我们约定:

  • 通过GET请求,获取电影分类的集合;
  • 通过GET请求,获取单个电影分类;
  • 通过POST请求,在电影分类集合中新增一个电影分类;
  • 通过PUT请求,更新单个电影分类;
  • 通过PATCH请求,增量更新单个电影分类;
  • 通过DELETE请求,删除单个电影分类;

电影模型的api接口规划

在电影模型中,我们约定:

  • 通过GET请求,获取电影的集合;
  • 通过GET请求,获取单个电影;
  • 通过POST请求,在电影集合中新增一个电影;
  • 通过PUT请求,更新单个电影;
  • 通过PATCH请求,增量更新单个电影;
  • 通过DELETE请求,删除单个电影;

观众模型的api接口规划

在观众模型中,我们约定:

  • 通过GET请求,获取观众的集合;
  • 通过GET请求,获取单个观众;
  • 通过POST请求,在观众集合中新增一个观众;
  • 通过PUT请求,更新单个观众;
  • 通过PATCH请求,增量更新单个观众;
  • 通过DELETE请求,删除单个观众;

电影评分模型的api接口规划

在电影评分模型中,我们约定:

  • 通过GET请求,获取电影评分的集合;
  • 通过GET请求,获取单个电影评分;
  • 通过POST请求,在电影评分集合中新增一个电影评分;
  • 通过PUT请求,更新单个电影评分;
  • 通过PATCH请求,增量更新单个电影评分;
  • 通过DELETE请求,删除单个电影评分;

通过这些规划和约定,我们能够在接下来编写相应资源的接口视图函数的时候能够清晰明了地完成接口的定义。

更多内容,我们下一篇文章见。

原文发布于微信公众号 - 州的先生(zmister2016)

原文发表时间:2018-07-09

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

编辑于

州的先生

1 篇文章54 人订阅

相关文章

来自专栏FreeBuf

爬虫采集去重优化浅谈

以前在做漏洞Fuzz爬虫时,曾做过URL去重相关的工作,当时是参考了seay法师的文章以及网上零碎的一些资料,感觉做的很简单。近来又遇到相关问题,于是乎有了再次...

3496
来自专栏数据和云

性能优化:B*Tree 索引中的数据块分配(五)

黄玮(Fuyuncat) 资深Oracle DBA,个人网www.HelloDBA.com,致力于数据库底层技术的研究,其作品获得广大同行的高度评价. 编辑手记...

2906
来自专栏蜉蝣禅修之道

fs学习笔记之输出格式

1913
来自专栏Java技术栈

浅析负载均衡的6种算法,Ngnix的5种算法。

常见的几种负载均衡算法 ? 1、轮询法 将请求按顺序轮流地分配到后端服务器上,它均衡地对待后端的每一台服务器,而不关心服务器实际的连接数和当前的系统负载。 2、...

33412
来自专栏开源优测

初学者阅读源码三板斧

1353
来自专栏小白安全

批量检测SQL注入工具

0×01 前言 SQL注入,这个类型的漏洞我真的学了好久好久好久好久,即是我刚刚开始接触安全就学习的第一种漏洞,也是一个迄今为止还在学习的漏洞类型,只...

9566
来自专栏marsggbo

tmux 简单介绍

1051
来自专栏安富莱嵌入式技术分享

emWin监护仪界面设计,含uCOS-III和FreeRTOS两个版本

配套例子: V6-908_STemWin提高篇实验_监护仪界面设计(uCOS-III) V6-909_STemWin提高篇实验_监护仪界面设计(FreeRTOS...

1685
来自专栏云计算

A Kubernetes Service Mesh(第9部分):使用gRPC的乐趣和收益

原文地址:https://dzone.com/articles/a-service-mesh-for-kubernetes-part-ix-grpc-for-f...

6379
来自专栏点滴积累

geotrellis使用(十八)导入多波段Tiff、读取多波段Tile

Geotrellis系列文章链接地址http://www.cnblogs.com/shoufengwei/p/5619419.html 目录 前言 多波段数...

4135

扫码关注云+社区

领取腾讯云代金券