RESTful

RESTful规范

什么是restful？

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

RESTful API设计

API接口：规定了前后台信息交互规则的url链接，也就是前后台信息交互的媒介

接口文档：可以手写或者自动生成···

restful规范一般遵循以下十条规则：

1. API与用户的通信协议，使用HTTPs协议来做数据的安全保障

2. 域名中会有api标识

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

3. 请求地址中带版本，或者在请求头中

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

4. 路径，视网络上任何东西都是资源，均使用名词表示（可复数），尽量减少动词的使用；

   • https://api.example.com/v1/books
   • https://api.example.com/v1/get_all_books（不符合规范）

5. 通过请求方式区分不同操作

   • GET ：从服务器取出资源（一项或多项）
   • POST ：在服务器新建一个资源
   • PUT ：在服务器更新资源（客户端提供改变后的完整资源）
   • PATCH ：在服务器更新资源（客户端提供改变的属性）
   • DELETE ：从服务器删除资源
     ps：patch是局部更新，put是全部（基本上更新都用put）

6. 在请求路径中带过滤标识

   • 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. 返回数据中带状态码

   • HTTP请求的状态码
   • 返回json格式中的状态码（自己/公司规定，用来标识请求返回的状态）

8. 返回数据中带错误信息

   • 错误处理，应返回错误信息，error当做key

   • {
         error: "Invalid API key"
     }
     

9. 对不同操作，返回数据符合如下规范

   GET /books：返回资源对象的列表（数组）[{},{},{}]
   GET /books/1：返回单个资源对象    {}
   POST /books：返回新生成的资源对象  {新增的书}
   PUT /books/1：返回完整的资源对象   {返回修改后的}
   PATCH /books/1： 返回完整的资源对象  {返回修改后的}
   DELETE /books/1：  返回一个空文档 
   # {status:100,msg:查询成功,data:null}
   

10. 返回结果中带连接

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

DRF

可以更方便的使用django写出符合restful规范的接口

下载安装

• pip3 install djangorestframework
• pycharm下载

注意

• rest_framework是一个app需要注册！

👉官网：https://www.django-rest-framework.org/

示例

'''views.py'''
from rest_framework.views import APIView
from rest_framework.response import Response


class Test(APIView):
    def get(self,request):
        data = {'status':200,'msg':'success'}
        return Response(data)
    def post(self,request):
        data = {'status': 200, 'msg': 'success'}
        return Response(data)
    
'''urls.py'''    
path('test/', views.Test.as_view()),
    
'''settings.py'''
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'app01.apps.App01Config',
    'rest_framework'
]

get请求

post请求