restful api 、状态码

http://www.cnblogs.com/wupeiqi/articles/7805382.html   银角博客Django Rest Framework  里面有各种东西

 ———————————————————————

http://www.cnblogs.com/wupeiqi/articles/7805382.html   十条规范，看银角博客

RESTful API设计

  • API与用户的通信协议，总是使用HTTPs协议。
  • 域名 
    • https://api.example.com                         尽量将API部署在专用域名（会存在跨域问题）
    • https://example.org/api/                        API很简单
  • 版本
    • URL，如：https://api.example.com/v1/
    • 请求头                                                  跨域时，引发发送多次请求
  • 路径，视网络上任何东西都是资源，均使用名词表示（可复数）
    • https://api.example.com/v1/zoos
    • https://api.example.com/v1/animals
    • https://api.example.com/v1/employees
  • method
    • GET      ：从服务器取出资源（一项或多项）
    • POST    ：在服务器新建一个资源
    • PUT      ：在服务器更新资源（客户端提供改变后的完整资源）
    • PATCH  ：在服务器更新资源（客户端提供改变的属性）
    • DELETE ：从服务器删除资源
  • 过滤，通过在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：指定筛选条件
  • 状态码
  • 错误处理，状态码是4xx时，应返回错误信息，error当做key。
    1
    2
    3
    {
        error: "Invalid API key"
    }
  • 返回结果，针对不同操作，服务器向用户返回的结果应该符合以下规范。
  • 1
    2
    3
    4
    5
    6
    GET /collection：返回资源对象的列表（数组）
    GET /collection/resource：返回单个资源对象
    POST /collection：返回新生成的资源对象
    PUT /collection/resource：返回完整的资源对象
    PATCH /collection/resource：返回完整的资源对象
    DELETE /collection/resource：返回一个空文档
  • Hypermedia API，RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。
    1
    2
    3
    4
    5
    6
    {"link": {
      "rel":   "collection https://www.example.com/zoos",
      "href":  "https://api.example.com/zoos",
      "title": "List of zoos",
      "type":  "application/vnd.yourformat+json"
    }}

 

 

rest API 10条规范；    流程------》》按照下面的流程记住，这样方便记忆。
https》》》域名》》版本》》名词》》url后可加条件，条件里面可加分页》》》》methods做请求》》return状态码，有错误信息发错误信息》》
返回值》》》headlink（这个是啥，不太确定）
———————————————————————

rest是一个规范，具体情况要具体分析，并不是死的。

restful api：（或者看上面的网址，里面是银角的博客）

　　一种软件架构风格、设计风格，而不是标准，只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁，更有层次，更易于实现缓存等机制。

谈谈你对restful api的认识？

把这个流程整理下
路由》》》视图》》as_view--- >返回view-->dispatch--->先有版本处理-->权限--->节流，走完之后通过反射取数据；》》》》》由解析器进行转换数据》》》》》》》序列化进行数据校验是否合法（ serialize来操作）》》》》数据正确需要用分页进行》》分页之后把数据返回给页面，页面进行渲染
原来web应用程序时，根据URL不同定位到不同视图函数处理。
        rest是一种规范：面向资源
http://api.luffycity.com/v1/users
            - 协议：
                http
                https
            - 域名
api.luffycity.com
www.luffycity.com/api
            - 版本
                
            - url中是名词
            - method不同执行不同函数：get/post/delete/put/patch
            - 返回状态码：200/301/302/404/403/500
            - 错误信息：
                {
                   msg: '用户名或密码错误'
                }
                def index(request):
                    ret = {'code':1000,'data':None}

                    return HttpResponse('xxx',status=200)
            - 返回值：
http://api.luffycity.com/v1/users
http://api.luffycity.com/v1/users/1
                
            - 条件
http://api.luffycity.com/v1/users?page=1&size=10
                
                PS: 主键ID体现在URL上
            - hyperlink
                {
                    id: '老司机',
                    age: 18,
                    group: http://www.luffycti.com/api/v1/group/1/
                }

 

很多内容请看银角博客，这里只放个状态码：》》

ps：自己博客整理状态码http://www.cnblogs.com/heysn21/articles/8808555.html

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

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

常用状态码列表

后者参考下面的状态码网址》》》

https://www.cnblogs.com/aure/p/6433014.html   状态码网址

 

 

 

 

 

posted @ 2018-04-15 17:05  Heartbreak-Utopia  阅读(1558)  评论(0)  编辑  收藏  举报