RestFramework——API设计规范

what‘s the RESTful

　　RestFramework是一个能快速为我们提供API接口，方便我们编程的框架。API是后端编程人员写的，为了让前端拿数据的一个接口，通常就是以url的形式存在。

　　每个项目总有第一个人做基础构架，这个时候就不是仅仅实现一个API就OK了，需要考虑更多的事情，包括

    • 　　统一的异常处理
    • 　　API权限
    • 　　统一的参数校验
    • 　　缓存如何可以做的更简单统一
    • 　　认证
    • 　　统一的查询过滤
    • 　　代码分层

RestFramework能很好的帮我们做这些事情。

了解RestFramework之前我们首先要知道什么是REST：

  • REST是一种标准，restful是一种规范，根据产品需求需要定出一份方便前后端的规范，与协议（如HTTP协议）不同，不是所有的标准要求都需要遵循。
  • REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”
  • REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识，客户端应用通过URL来获取资源的表征，获得这些表征致使这些应用转变状态
  • 所有的数据，不过是通过网络获取的还是操作（增删改查）的数据，都是资源，将一切数据视为资源是REST区别与其他架构风格的最本质属性
  • 对于REST这种面向资源的架构风格，有人提出一种全新的结构理念，即：面向资源架构（ROA：Resource Oriented Architecture）

API设计规范

　　首先我们要知道，API并不是必须的，如果整个项目只有你一个人或者很少的人完成，完全可以直接用Django的模板引擎渲染发送到前端后直接操作。API的使用主要是为了解决多人开发，特别是前后端分离的情况。因为前端人员在制作页面时必然会需要向后端要数据，但是假如前后端是分离的，就不能用Django的render了，大部分情况前端会用ajax发送请求，后端人员则发送JSON字符串给前端，前端再反序列化后进行使用。这个时候其实我们设计一套API出来，就能使我们的任务轻松很多。所以，RestFramework就应运而生了。

　　API与用户的通信协议，本质上是HTTPs协议。

使用RestFramework设计API有一套规范，即RESTful，为了不平添与你合作开发的人的烦恼，我们还是要遵循这些规范。那么到底有哪些规范呢？

  1. 域名：域名上要显示你使用了API，我们有两种方式

    • https://api.example.com                  方式一：将API部署在专用域名上（是官网的推荐方式，但这么做会存在跨域问题）
    • https://example.org/api/                  方式二： 写在路径上，API很简单
  2. 版本：我们的项目在开发过程中会进行功能的添加及优化，这个时候我们通常会为每一个版本设定一个版本号，版本号的显示也有两种方式
    • https://api.example.com/v1/　　     方式一： 写在路径上，API很简单
    • https://v1.example.com                   方式二：将版本号部署在专用域名上（同样会存在跨域问题， 跨域时会引发发送多次请求）
  3. 路径：视网络上任何东西都是资源，所以路径均使用名词表示（可复数）
    • https://api.example.com/v1/zoos
    • https://api.example.com/v1/animals
  4. 请求方式：
    • GET      ：从服务器取出资源（一项或多项）
    • POST    ：在服务器新建一个资源
    • PUT      ：在服务器更新资源（客户端提供改变后的完整资源——全部修改）
    • PATCH  ：在服务器更新资源（客户端提供改变的属性——部分修改）
    • DELETE ：从服务器删除资源
  5. 过滤：通过在URL上传参的方式，有GET请求获取相应的数据
    • https://api.example.com/v1/zoos?limit=10：指定返回数据的数量
    • https://api.example.com/v1/zoos?offset=10：指定返回数据的开始位置
    • https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页以及每页的数据数量
    • https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序
    • https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件
  6. 状态码：我们可以通过状态码来判断请求的状态，以处理相应的请求。在状态码是4开头时，应该捕捉相应错误并返回错误信息

    200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
204 NO CONTENT - [DELETE]：用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

更多看这里：http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

    常用状态码

    {error: "Invalid API key"}#错误信息因用error作为key
  7. 返回结果：针对不同操作，服务器向用户返回的结果应该符合以下规范。
    • GET/collection：返回资源对象的列表
    • GET/collection/resource：返回单个资源对象
    • POST/collection：返回新生成的资源对象
    • PUT/collection/resource：返回完整的资源对象
    • PATCH/collection/resource：返回完整的资源对象
    • DELETE/collection/resource：返回一个空文档
    • 　
  8. Hypermedia API：RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。

    {"link": {
  "rel":   "collection https://www.example.com/zoos",
  "href":  "https://api.example.com/zoos",
  "title": "List of zoos",
  "type":  "application/vnd.yourformat+json"
}}

原文地址：https://www.cnblogs.com/zhuminghui/p/8432359.html

时间： 2024-07-28 17:00:28

RestFramework——API设计规范的相关文章

BaaS API 设计规范

上个月写了一个团队中的 BaaS API 的设计规范,给大家分享下: 目录 1. 引言... 4 1.1. 概要... 4 1.2. 参考资料... 4 1.3. 阅读对象... 4 1.4. 术语解释... 4 2. API 设计规范... 5 2.1. 地址格式... 5 2.2. 输入与输出... 6 2.2.1. 通用输入数据... 6 2.2.2. 主体输入... 6 2.2.3. 通用输出数据... 6 2.2.4. 状态码... 7 2.2.5. 异常处理... 7 2.2.6.

REST API设计规范

完全面向资源,API以复数形式表示 路径(Endpoint) http://example.com/libraries //列出所有图书馆 http://example.com/books //列出所有图书 http://example.com/libraries/ID/books //列出某个图书馆的全部图书 http://example.com/libraries/ID/books/ID //列出某个图书馆的某本图书 筛选条件 http://example.com/books?library

API设计规范 ----Restful

Restful API设计指南 接下来我将介绍RESTful API的设计细节,探讨如何设计一套合理.好用的API 一.协议 API与用户的通信协议,总是使用HTTPs协议. 二.域名 应该尽量将API部署在专用域名之下. https://api.example.com 如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下. https://example.org/api/ 三.版本(Versioning) 应该将API的版本号放入URL. https://api.example.com

RESTful API设计规范收集

说明:其实没有绝对的规范,达到90%即可. 理解RESTful架构:http://www.ruanyifeng.com/blog/2011/09/restful.html RESTful API 设计指南:http://www.ruanyifeng.com/blog/2014/05/restful_api.html GitHub标准RESTful API:https://api.github.com/ 教程收集: http://novoland.github.io/%E8%AE%BE%E8%AE

Restful API设计规范及实战

Restful API的概念在此就不费口舌了,博友们网上查哈定义文章很多,直入正题吧: 首先抛出一个问题:判断id为 用户下,名称为 使命召唤14(COD14) 的产品是否存在(话说我还是很喜欢玩类似二战的使命召唤这款额,题外话...)?如果这个问题出现在 MVC 项目中,我想我们一般会这样设计: api/products/isexist/{userId}/{productName} 我想你应该发现一些问题了,这种写法完全是 MVC 的方式,但并不适用于 WebAPI,主要有三个问题:Route

Restful Api设计规范

网络应用程序,分为前端和后端两个部分.当前的发展趋势,就是前端设备层出不穷(手机.平板.桌面电脑.其他专用设备......). 因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信.这导致API构架的流行,甚至出现"API First"的设计思想.RESTful API是目前比较成熟的一套互联网应用程序的API设计理论.我以前写过一篇<理解RESTful架构>,探讨如何理解这个概念. 今天,我将介绍RESTful API的设计细节,探讨如何设计一套合理.好用的API

API设计规范---RESTful架构详解

1. 什么是REST REST全称是Representational State Transfer,中文意思是表述(编者注:通常译为表征)性状态转移. 它首次出现在2000年Roy Fielding的博士论文中,Roy Fielding是HTTP规范的主要编写者之一. 他在论文中提到:"我这篇文章的写作目的,就是想在符合架构原理的前提下,理解和评估以网络为基础的应用软件的架构设计,得到一个功能强.性能好.适宜通信的架构.REST指的是一组架构约束条件和原则." 如果一个架构符合REST

restframework api（基础2）

本篇基于http://www.cnblogs.com/wanstack/p/9008872.html 下面主要是整理一下django的相关知识,希望能有意外的收获. 看到了一篇好的文章,忍不住的想要抄袭下来... 原文地址https://www.jianshu.com/p/17d8266bb265 下面开始我的抄袭之路... 原文地址:https://www.cnblogs.com/wanstack/p/9025964.html

restframework api（基础3CBV）

一 CBV源码流程 urls.py from django.conf.urls import url from django.contrib import admin from app01 import views urlpatterns = [ url(r'^order/', views.OrderView.as_view()), ] view.py from django.shortcuts import render from django.http import JsonResponse