• restful规范


    REST简介

    REST(英文:Representational State Transfer,简称REST)描述了一个架构样式的网络系统,比如 web 应用程序。在目前主流的三种Web服务交互方案中,REST相比于SOAP(Simple Object Access protocol,简单对象访问协议)以及XML-RPC更加简单明了,无论是对URL的处理还是对Payload的编码,REST都倾向于用更加简单轻量的方法设计和实现。

    • REST与技术无关,代表的是一种软件架构风格,REST是Representational State Transfer的简称,中文翻译为“表征状态转移”
    • 所有的数据,不过是通过网络获取的还是操作(增删改查)的数据,都是资源,将一切数据视为资源是REST区别与其他架构风格的最本质属性
    • 对于REST这种面向资源的架构风格,有人提出一种全新的结构理念,即:面向资源架构(ROA:Resource Oriented Architecture)

    协议

    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):从服务器删除资源。
    
    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的网址列表。

    django实现restful规范

    settings.py

    INSTALLED_APPS = [
           。。。   
        "rest_framework",
    ]

    urls.py

    urlpatterns = [
        url(r'^admin/', admin.site.urls),
        url(r'^books/', views.Book.as_view()),
    ]

    views.py

    from rest_framework.views import APIView
    
    class Book(APIView):
        def get(self, request):
            book_list = models.Book.objects.all()
            books = [{"书名": book.title, "出版时间": book.publish_time, "出版社": book.publish.name,
                      "authors": [a.name for a in book.authors.all()]} for book in book_list]
            back_dic = {"code": 100, "data": books}
            return JsonResponse(back_dic, json_dumps_params={"ensure_ascii": False}, safe=False)
    
    
        def post(self, request):
            print(type(request.POST))
            title = request.POST.get("title")
            publish_id = request.POST.get("publish_id")
            models.Book.objects.create(title=title, publish_id=publish_id)
            return HttpResponse("ok")
    

      

    APIView源码细说:

  • 相关阅读:
    C# — WinForm TCP连接之服务器端
    Linq to SQL — Group by
    pytorch model()[] 模型对象类型
    git官网下载太慢解决方法
    财务分析
    python错题集
    SQL 开窗函数 头尾函数 first_value()/last value()不常用
    徐杨老师的公开课关于敏捷算法
    SQL 开窗函数:range和rows的区别
    SQL开窗函数 row_number(),dense_rank(), rank()
  • 原文地址:https://www.cnblogs.com/penghengshan/p/11129173.html
Copyright © 2020-2023  润新知