RESTful Web API--設計風格

時間 2019-12-08

標籤 restful web api 設計風格欄目 HTML 简体版

原文原文鏈接

原文地址：http://www.cnblogs.com/artech/p/restful-web-api-02.html

RESTful背景介紹

　　2000年，Roy Thomas Fielding博士在他那篇著名的博士論文《Architectural Styles and the Design of Network-based Software Architectures》中提出了幾種軟件應用的架構風格，REST做爲其中的一種架構風格在這篇論文的第5章中進行了歸納性的介紹。html

　　REST是「REpresentational State Transfer」的縮寫，能夠翻譯成「表現狀態轉換」，可是在絕大多數場合中咱們只說REST或者RESTful。web

　　Fielding在論文中將REST定位爲「分佈式超媒體應用（Distributed Hypermedia System）」的架構風格，它在文中提到一個名爲「HATEOAS（Hypermedia as the engine of application state）」的概念。api

採用URI標識資源

　　SOAP Web API採用RPC風格，它採用面向功能的架構，因此咱們在設計SOAP Web API的時候首相考慮的是應高提供怎樣的功能（或者操做）。安全

　　RESTful Web API採用面向資源的架構，因此在設計之初首先須要考慮的是有哪些資源可供操做。服務器

　　一個資源必須具備一個或者多個標識，既然咱們設計的Web API，那麼很天然地應該採用URI來做爲資源的標識。restful

　　除了必要的標誌性和可選的可讀性以外，標識資源的URI應該具備「可尋址性（Addressability）」。數據結構

　　URI不只僅指明瞭被標識資源所在的位置，並且經過這個URI能夠直接獲取目標資源。架構

使用「連接」關聯相關的資源

　　在絕大多數狀況下，資源並不會孤立地存在，必然與其它資源具備某種關聯。app

　　利用URL將資源關聯在一塊兒，就是一份超文本/超媒體文檔，咱們能夠根據須要獲取對應的資源，這也是爬蟲的實現原理。負載均衡

　　Fielding在他的論文中將REST定位爲「分佈式超媒體應用」的架構風格，而超媒體的核心就是利用「連接」相關的信息結成一個非線性的網，因此從一點也能夠看出REST和「使用連接關聯相關的資源」這個特性使吻合的。

使用統一的接口

　　可否採用統一接口是RESTful Web API和採用RPC風格的SOAP Web服務又一區別。

   #RPC風格
　 1: public class RoleService
   2: {
   3:     public IEnumerable<string> GetAllRoles();
   4:     public void CreateRole(string roleName);
   5:     public void DeleteRole(string roleName);
   6:     public void AddRolesInUser(string userName, string[] roleNames);
   7:     public void RemoveRolesFromUser(string userName, string[] roleNames);
   8: }

#RESTful
   1: public class RolesService
   2: {
   3:     public IEnumerable<string> Get();
   4:     public void Create(string roleName);
   5:     public void Delete(string roleName);
   6: }
   7:  
   8: public class RoleAssignmentsService
   9: {
  10:     public void Create(RoleAssignment roleName);
  11:     public void Delete(RoleAssignment roleName);
  12: }