南宁网站建设公司招聘,中国沈阳网站在哪里下载,请人建网站,淮南建设网站一、重要概念#xff1a;REST,即Representational State Transfer的缩写。我对这个词组的翻译是表现层状态转化。Resource(资源) #xff1a;对象的单个实例。 例如#xff0c;一只动物。它可以是一段文本、一张图片、一首歌曲、一种服务#xff0c;总之就是一…一、重要概念REST,即Representational State Transfer的缩写。我对这个词组的翻译是表现层状态转化。Resource(资源) 对象的单个实例。 例如一只动物。它可以是一段文本、一张图片、一首歌曲、一种服务总之就是一个具体的实在。你可以用一个URI(统一资源定位符)指向它每种资源对应一个特定的URI。要获取这个资源访问它的URI就可以因此URI就成了每一个资源的地址或独一无二的识别符。集合对象的集合。 例如动物。第三方使用我们接口的开发者表现层(Representation)资源是一种信息实体它可以有多种外在表现形式。我们把资源具体呈现出来的形式叫做它的表现层(Representation)。状态转化(State Transfer)访问一个网站就代表了客户端和服务器的一个互动过程。在这个过程中势必涉及到数据和状态的变化。互联网通信协议HTTP协议是一个无状态协议。这意味着所有的状态都保存在服务器端。因此如果客户端想要操作服务器必须通过某种手段让服务器端发生状态转化(State Transfer)。而这种转化是建立在表现层之上的所以就是表现层状态转化。客户端用到的手段只能是HTTP协议。具体来说就是HTTP协议里面四个表示操作方式的动词GET、POST、PUT、DELETE。它们分别对应四种基本操作GET用来获取资源POST用来新建资源(也可以用于更新资源)PUT用来更新资源DELETE用来删除资源。比如文本可以用txt格式表现也可以用HTML格式、XML格式、JSON格式表现甚至可以采用二进制格式图片可以用JPG格式表现也可以用PNG格式表现。URI只代表资源的实体不代表它的形式。严格地说有些网址最后的.html后缀名是不必要的因为这个后缀名表示格式属于表现层范畴而URI应该只代表资源的位置。它的具体表现形式应该在HTTP请求的头信息中用Accept和Content-Type字段指定这两个字段才是对表现层的描述。综合上面的解释我们总结一下什么是RESTful架构(1)每一个URI代表一种资源(2)客户端和服务器之间传递这种资源的某种表现层(3)客户端通过四个HTTP动词对服务器端资源进行操作实现表现层状态转化。二、REST接口规范1、动作GET (SELECT)从服务器检索特定资源或资源列表。POST (CREATE)在服务器上创建一个新的资源。PUT (UPDATE)更新服务器上的资源提供整个资源。PATCH (UPDATE)更新服务器上的资源仅提供更改的属性。DELETE (DELETE)从服务器删除资源。首先是四个半种动作post、delete、put/patch、get因为put/patch只能算作一类所以将patch归为半个。另外还有有两个较少知名的HTTP动词HEAD - 检索有关资源的元数据例如数据的哈希或上次更新时间。OPTIONS - 检索关于客户端被允许对资源做什么的信息。2、路径(接口命名)路径又称终点(endpoint)表示API的具体网址。在RESTful架构中每个网址代表一种资源(resource)所以网址中不能有动词只能有名词而且所用的名词往往与数据库的表格名对应。一般来说数据库中的表都是同种记录的集合(collection)所以API中的名词也应该使用复数。举例来说有一个API提供动物园(zoo)的信息还包括各种动物和雇员的信息则它的路径应该设计成下面这样。接口尽量使用名词禁止使用动词下面是一些例子。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删除某个指定动物园的指定动物反例/getAllCars/createNewCar/deleteAllRedCars再比如某个URI是/posts/show/1其中show是动词这个URI就设计错了正确的写法应该是/posts/1然后用GET方法表示show。如果某些动作是HTTP动词表示不了的你就应该把动作做成一种资源。比如网上汇款从账户1向账户2汇款500元错误的URI是POST /accounts/1/transfer/500/to/2正确的写法是把动词transfer改成名词transaction资源不能是动词但是可以是一种服务POST /transaction HTTP/1.1Host: 127.0.0.1from1to2amount500.00理清资源的层次结构比如业务针对的范围是学校那么学校会是一级资源(/school)老师(/school/teachers)学生(/school/students)就是二级资源。3、版本(Versioning)应该将API的版本号放入URL。如https://api.example.com/v1/另一种做法是将版本号放在HTTP头信息中但不如放入URL方便和直观。Github采用这种做法。4、过滤信息(Filtering)如果记录数量很多服务器不可能都将它们返回给用户。API应该提供参数过滤返回结果。下面是一些常见的参数。?limit10指定返回记录的数量?offset10指定返回记录的开始位置。?page_number2page_size100指定第几页以及每页的记录数。?sortbynameorderasc指定返回结果按照哪个属性排序以及排序顺序。?animal_type_id1指定筛选条件参数的设计允许存在冗余即允许API路径和URL参数偶尔有重复。比如GET /zoo/ID/animals 与 GET /animals?zoo_idID 的含义是相同的。5、状态码(Status Codes)状态码范围1xx 信息请求收到继续处理。范围保留用于底层HTTP的东西你很可能永远也用不到。2xx 成功行为被成功地接受、理解和采纳3xx 重定向为了完成请求必须进一步执行的动作4xx 客户端错误请求包含语法错误或者请求无法实现。范围保留用于响应客户端做出的错误例如。他们提供不良数据或要求不存在的东西。这些请求应该是幂等的而不是更改服务器的状态。5xx 范围的状态码是保留给服务器端错误用的。这些错误常常是从底层的函数抛出来的甚至开发人员也通常没法处理发送这类状态码的目的以确保客户端获得某种响应。当收到5xx响应时客户端不可能知道服务器的状态所以这类状态码是要尽可能的避免。服务器向用户返回的状态码和提示信息常见的有以下一些(方括号中是该状态码对应的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 - [*]服务器发生错误用户将无法判断发出的请求是否成功。502 网关错误503 Service Unavailable504 网关超时错误处理(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 APIRESTful 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.yourformatjson}}上面代码表示文档中有一个link属性用户读取这个属性就知道下一步该调用什么API了。rel表示这个API与当前网址的关系(collection关系并给出该collection的网址)href表示API的路径title表示API的标题type表示返回类型。Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计访问api.github.com会得到一个所有可用API的网址列表。{current_user_url: https://api.github.com/user,authorizations_url: https://api.github.com/authorizations,// ...}从上面可以看到如果想获取当前用户的信息应该去访问api.github.com/user然后就得到了下面结果。{message: Requires authentication,documentation_url: https://developer.github.com/v3}上面代码表示服务器给出了提示信息以及文档的网址。
