zoukankan      html  css  js  c++  java

  • Rest Framework简介 和 RESTful API 设计指南

    使用Django Rest Framework之前我们要先知道，它是什么，能干什么用？

    Django Rest Framework 是一个强大且灵活的工具包，用以构建Web API

    为什么要使用Rest Framework

    Django REST Framework可以在Django的基础上迅速实现API，并且自身还带有WEB的测试页面，可以方便的测试自己的API

    web应用模式分两种：

    1. 前后端不分离

    在前后端不分离的引用模式中，前端页面看到的效果都是由后端控制的，由后端页面渲染或者重定向，也就是后端需要控制前端的展示，前端与后端的耦合度很高，这种模式比较适合纯网页应用，但是后端对接APP时，App可能并不需要后端返回一个HTML网页,二仅仅是数据本身,所以后端原本返回网页的接口不在适用前端APP应用,为了对接APP后端嗨需再开发一套接口。

    这个可以看我之前写的DJango博客就可以知道，每次返回时都是使用render 或者redirect来返回的，需要带上HTML页面和参数

    2. 前后端分离

    在前后端分离的应用模式中，后端仅返回前端所需要的数据，不再渲染HTML页面，不再控制前端的效果，只要前端用户看到什么效果，从后端请求的数据如何加载到前端中，都由前端自己决定，网页有网页自己的处理方式，APP有APP的处理方式，但无论哪种前端所需要的数据基本相同，后端仅需开发一套逻辑对外提供数据即可，在前后端分离的应用模式中,前端与后端的耦合度相对较低

    在前后端分离的应用模式中,我们通常将后端开发的每一视图都成为一个接口,或者API,前端通过访问接口来对数据进行增删改查

    如果项目的需求是后一种情况的话，那么就可以用到Django Rest Framework了

    Django REST framework 简介

    序列化和反序列化可以复用
    增:  效验请求数据>执行反序列化过程>保存数据库>将保存的对象序列化并返回
    删:  判断要删除的数据是否存在.>执行数据库删除
    改:  判断要修改的数据是否存在>效验请求的参数>执行反序列化过程>保存数据库>将保存的对象序列化并返回
    查:  查询数据库>将数据序列化并返回


    特点:
    1. 提供了定义序列化器Serializer的方法,可以快速根据Django ORM 或者其他库自动序列化/反序列化
    2. 提供了丰富的类视图MIXIN扩展类,简化视图的编写
    3. 丰富的定制层级:函数视图类视图试图结合到自动生成API,满足各种需要
    4. 多种身份认证和权限认证方式的支持
    5. 内置了限流系统
    6. 直观的API web界面
    7. 可扩展性 , 插件丰富

    Django REST framework 的核心任务

    使用Django Rest framework的话，和之前使用Django时没多大差别，当然，更复杂的差别我也不知道

    1.   多了个serializers.py文件

    这个文件的作用是Serializers把querysets和model instances这些复杂的数据结构转化为native Python 以便于以json,xml或其它内容类型的形式render出去。

    2. 视图的核心功能变了

    1.  将数据库数据序列化为前端需要的格式，并返回

    2. 将前端发送过来的数据反序列化为模型类对象，并保存到数据库中

    RESTful API 设计指南

    简介

    REST（英文：Representational State Transfer，简称REST）描述了一个架构样式的网络系统，比如 web 应用程序。它首次出现在 2000 年 Roy Fielding 的博士论文中，他是 HTTP 规范的主要编写者之一。在目前主流的三种Web服务交互方案中，REST相比于SOAP（Simple Object Access protocol，简单对象访问协议）以及XML-RPC更加简单明了，无论是对URL的处理还是对Payload的编码，REST都倾向于用更加简单轻量的方法设计和实现。值得注意的是REST并没有一个明确的标准，而更像是一种设计的风格。

    定义：简单来说REST是一种系统架构设计风格（而非标准），一种分布式系统的应用层解决方案。

    目的：Client和Server端进一步解耦。

    一、协议

    API与用户的通信协议，总是使用HTTPs协议。

    二、域名

    1.应该尽量将API部署在专用域名之下,(这中情况会存在跨域问题)

    https://api.example.com

    2.如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。

    https://example.org/api/

    三、版本（Versioning）

    应该将API的版本号放入URL。

    https://api.example.com/v1/

    另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。Github采用这种做法。

    四、路径（Endpoint）

    路径又称"终点"（endpoint），表示API的具体网址。

    在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。

    举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。

    • https://api.example.com/v1/zoos

    • https://api.example.com/v1/animals

    • https://api.example.com/v1/employees

    五、HTTP动词

    对于资源的具体操作类型，由HTTP动词表示。

    常用的HTTP动词有下面五个（括号里是对应的SQL命令）。

    • GET（SELECT）：从服务器取出资源（一项或多项）。

    • POST（CREATE）：在服务器新建一个资源。

    • PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。

    • PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。

    • DELETE（DELETE）：从服务器删除资源。

    还有两个不常用的HTTP动词。

    • HEAD：获取资源的元数据。

    • OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

    下面是一些例子。

    • GET /zoos：列出所有动物园

    • POST /zoos：新建一个动物园

    • GET /zoos/ID：获取某个指定动物园的信息

    • PUT /zoos/ID：更新某个指定动物园的信息（提供该动物园的全部信息）

    • PATCH /zoos/ID：更新某个指定动物园的信息（提供该动物园的部分信息）

    • DELETE /zoos/ID：删除某个动物园

    • GET /zoos/ID/animals：列出某个指定动物园的所有动物

    • DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物

    六、过滤信息（Filtering）

    如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。

    下面是一些常见的参数。

    • 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：指定筛选条件

    参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。

    七、状态码（Status Codes）

    服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。

    • 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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

     状态码的完全列表参见这里。

    八、错误处理（Error handling）

    如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。

    {
    error: "Invalid API key"
}

    九、返回结果

    针对不同操作，服务器向用户返回的结果应该符合以下规范。

    • GET /collection：返回资源对象的列表（数组）

    • GET /collection/resource：返回单个资源对象

    • POST /collection：返回新生成的资源对象

    • PUT /collection/resource：返回完整的资源对象

    • PATCH /collection/resource：返回完整的资源对象

    • DELETE /collection/resource：返回一个空文档

    十、Hypermedia API

    RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。

    比如，当用户向api.example.com的根目录发出请求，会得到这样一个文档。

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

    上面代码表示，文档中有一个link属性，用户读取这个属性就知道下一步该调用什么API了。rel表示这个API与当前网址的关系（collection关系，并给出该collection的网址），href表示API的路径，title表示API的标题，type表示返回类型。

    Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计，访问api.github.com会得到一个所有可用API的网址列表。

    {
  "current_user_url": "https://api.github.com/user",
  "authorizations_url": "https://api.github.com/authorizations",
  // ...
}
    从上面可以看到，如果想获取当前用户的信息，应该去访问api.github.com/user，然后就得到了下面结果。
    {
  "message": "Requires authentication",
  "documentation_url": "https://developer.github.com/v3"
}

    上面代码表示，服务器给出了提示信息，以及文档的网址。

    其他

    （1）API的身份认证应该使用OAuth 2.0框架。

    （2）服务器返回的数据格式，应该尽量使用JSON，避免使用XML。

    end。。。
  • 相关阅读:
    user.table.column, table.column 或列说明无效
    spring计划任务，springMvc计划任务，Spring@Scheduled，spring定时任务
    easyui-treegrid移除树节点出错
    jquery easyui easyui-treegrid 使用异步加载数据
    Java动态调用webService，axis2动态调用webService
    让IE支持Css3属性（圆角、阴影、渐变）
    float浮动之后高度自适应失效解决方案
    td中使用overflow:hidden; 无效解决方案
    jquery插件select2事件不起作用（select2-3.5.4）
    wsdl自动生成Java代码，根据wsdl生成Java代码
  • 原文地址：https://www.cnblogs.com/edeny/p/10024508.html
Copyright © 2011-2022 走看看