您的位置: 首页  >  IT文章  >  DRF之restful规范、Postman接口测试 一. DRF简介 二. 开发模式 三. restful规范  四. Postman的使用 五. 其他知识点补充

DRF之restful规范、Postman接口测试 一. DRF简介 二. 开发模式 三. restful规范  四. Postman的使用 五. 其他知识点补充

分类: IT文章 • 2022-05-07 23:05:45

　　Django REST框架是一个功能强大且灵活的工具包，用于构建Web API。

　　使用REST框架的一些原因：

  • 该网站可浏览API是你的开发人员一个巨大的可用性胜利。
  • 身份验证策略包括OAuth1a和OAuth2的程序包。
  • 支持ORM和非ORM数据源的序列化。
  • 可自定义 - 如果您不需要更强大的功能，只需使用常规的基于功能的视图。
  • 丰富的文档和良好的社区支持。
  • 由国际知名公司使用和信任，包括Mozilla，Red Hat，Heroku和Eventbrite。

　　此处附上官方文档链接：https://www.django-rest-framework.org/，再次强调，无论如何都要养成看官方文档的能力与习惯，使用过程中可以从官方文档中查找。

二. 开发模式

　　开发模式分为前后端分离、前后端不分离。

2.1 前后端不分离

　　在前后端不分离的引用模式中，前端页面看到的效果都是由后端控制的，由后端页面渲染或者重定向，也就是后端需要控制前端的展示，前端与后端的耦合度很高，这种模式比较适合纯网页应用。

　　数据请求如下：

DRF之restful规范、Postman接口测试 一. DRF简介 二. 开发模式 三. restful规范  四. Postman的使用 五. 其他知识点补充

2.2 前后端分离

　　有时候前端并不需要后端返回渲染的HTML页面，只需要后端返回需要数据。

　　相比前后端不分离，前后端分离具有很多优势。

  • 前后端分离之后，前后端都有各自的服务器，这就意味着可以水平扩展前后端服务器增加并发。
  • 实现真正的前后端解耦，前后端并行开发，增加了开发效率。
  • 减少了后端服务器的并发/负载压力。
  • 前后端通过接口进行数据交互，无论后端是什么语言，只要提供相应的接口即可同前端交互。

　　前后端分离的优点有很多，具体可以百度。

三. restful规范

　　前后端交互必须有一种统一的机制来方便不同的前端设备与后端进行通信，而restful目前比较成熟的一套互联网应用程序的API设计理论。

3.1 什么是restful

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

3.2 restful API设计

　　1. 协议

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

　　2. 域名

　　有以下两种方式，第一种方式相比第二种较复杂。

  • https://api.example.com                         尽量将API部署在专用域名（会存在跨域问题）
  • https://example.org/api/                          API很简单

　　3. 版本

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

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

　　还可以将版本号放入HTTP头信息中，但不如放入URL方便与直观。

　　4. 路径

　　路径又称"终点"（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

 　　5. method

　　路径是资源，而method是用来标识我们要对资源进行的操作。

GET（SELECT）：从服务器取出资源（一项或多项）。
POST（CREATE）：在服务器新建一个资源。
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
DELETE（DELETE）：从服务器删除资源。

　　还有两个不常用的方法：

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：删除某个指定动物园的指定动物

　　6. 过滤信息

　　通过在url上传参的形式传递搜索条件。

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

 　　7. 状态码

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://tool.oschina.net/commons?type=5

　　8. 错误处理

 　　应返回错误信息，error当做key。

{
    error: "Invalid API key"
}

　　9. 返回结果

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

GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
PATCH /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档

　　10. 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"
}}

 3.3 基于Django实现

　　路由层urls.py

urlpatterns = [
    url(r'^users/$', views.Users.as_view()),
    url(r'^users2/$', views.user2),

]

　　视图函数views.py

import json

def  user2(request):
    if request.method=='GET':
        dic = {'status':200,'name': 'lqz2', 'age': 18}
        return HttpResponse(json.dumps(dic))
    elif request.method=='POST':
        dic = {'status': 200, 'msg': '修改成功'}
        return JsonResponse(dic)

class Users(View):
    def get(self, request):
        dic = {'status':200,'name': 'lqz', 'age': 18}
        return HttpResponse(json.dumps(dic))

    def post(self, request):
        dic = {'status': 200, 'msg': '修改成功'}
        return JsonResponse(dic)

 四. Postman的使用

　　前后端分离是当下的主流，此时后端只需要保证接口正常即可，而Postman是一个模拟向接口发送请求，测试接口的软件，在后端开发时，我们可以使用该软件来测试接口。

 　　Postman官网：https://www.getpostman.com/downloads/

DRF之restful规范、Postman接口测试 一. DRF简介 二. 开发模式 三. restful规范  四. Postman的使用 五. 其他知识点补充

 　　由于前后端交互用的都是json格式的字符串，为了增加json字符串的可读性，可以使用该网站：https://www.json.cn/

五. 其他知识点补充

5.1 跨域

　　指的是浏览器不能执行其他网站的脚本。它是由浏览器的同源策略造成的，是浏览器对javascript施加的安全限制。同源策略是指协议，域名，端口都要相同，其中有一个不同都会产生跨域。

DRF之restful规范、Postman接口测试 一. DRF简介 二. 开发模式 三. restful规范  四. Postman的使用 五. 其他知识点补充

　　跨域解决的几种方式：https://www.imooc.com/article/21976

5.2 301与302的区别

　　可观看该博客：https://blog.****.net/u013542440/article/details/51346392

5.3 layui

　　前端除了可以使用Bootstrap搭建页面外，还可以使用layui，详情点击链接：https://www.layui.com/demo/grid.html

5.4 IDE

　　集成开发环境（IDE，Integrated Development Environment ）是用于提供程序开发环境的应用程序，一般包括代码编辑器、编译器、调试器和图形用户界面等工具。集成了代码编写功能、分析功能、编译功能、调试功能等一体化的开发软件服务套。所有具备这一特性的软件或者软件套（组）都可以叫集成开发环境。如微软的Visual Studio系列，Borland的C++ Builder、Delphi系列等。该程序可以独立运行，也可以和其它程序并用。IDE多被用于开发HTML应用软件。例如，许多人在设计网站时使用IDE（如HomeSite、DreamWeaver等），因为很多项任务会自动生成。

5.5 DG

　　全称DataGrip，是JetBrains公司出品的一款数据库管理工具，实际上Pycharm中的数据库管理工具是嵌入了DataGrip的一个小模块，总之还是挺强大的，详情可至官网查看。

　　

相关推荐