zoukankan      html  css  js  c++  java
  • RESTful规范

    RESTful规范

    1.RESTful规范的定义

    ​ 1)代表的是一种软件架构分格,中文译为'表征状态转移'

    ​ 2)是面向资源编程

    2.RESTful10条规范

    ​ 1)API与用户的通信协议,总是使用HTTPs协议

    ​ 2)域名的设计​

    ​ 一个查询所有图书的api接口:https://api.example.com/books

    https://127.0.0.1/api/books (推荐使用)

    ​ 3)每个接口都应该有版本

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

    https://127.0.0.1/api/v2/books(推荐用这种)

    ​ 4)路径,视网络上任何东西都是资源,均使用名词表示(可以使用复数)

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

    ​ 5)method

    ​ GET:从服务器中取数据

    ​ POST:在服务器中新建数据

    ​ PUT:在服务器中更新资源(客户端提供改变后的完整数据)

    ​ PATCH:在服务器中更新资源(客户端提供要改变的属性)

    ​ DELETE:从服务器中删除数据

    ​ 6)过滤,通过在url上传参的形式传递搜索条件

    https://api.example.com/v1/zoos?limit=10:指定返回记录的数量

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

    ​ 8)错误信息处理,error当做key

    ​ {error:'错误信息'}

    ​ 9)返回结果

    ​ GET:返回资源对象

    ​ POST:返回生成的新对象

    ​ PUT:返回完整的资源对象

    ​ PATCH:返回完整的资源对象

    ​ DELETE:返回一个空文档

    ​ 10)Hypermedia API,RESTful API最好做到Hypermedia,即返回结果中提供链接,连向其他API

    {
                  status:100
                  msg:成功
                  url:127.0.0.1/books/1
               }
    
  • 相关阅读:
    Win10 开启IIS后,访问“localhost”,报错无“C:WindowsMicrosoft.NETFramework64v4.0.30319Temporary ASP.NET Files”写访问权限
    使用pip安装Python扩展包时,如何提高速度?
    Django之路由层
    第一个Django项目
    Django简介
    DIY一个Web框架
    http协议
    Web应用和Web框架
    Python递归的经典案例
    Python修改文件的两种方法
  • 原文地址:https://www.cnblogs.com/jianhaozhou/p/10098607.html
Copyright © 2011-2022 走看看