Web-API设计方法-简写-李锟

REST、超媒体与WebAPI拥抱Web原生的架构设计原则,主讲人：李锟,什么是REST？,什么是REST？,全称RepresentationalStateTransfer（表述性状态移交）由RoyFielding在其2000年的博士论文ArchitecturalStylesandtheDesignofNetwork-basedSoftwareArchitectures（架构风格与基于网络应用软件的架构设计）中提出有两种理解方式REST是一种抽象的架构风格（architecturalstyle）REST是一种为面向互联网的应用软件量身定制的架构风格REST是Web自身的架构风格，是Web取得巨大成功在技术层面的原因和理论基础REST在Web上是普适的，同时适用于Web应用和WebAPIREST是一种分布式应用的架构设计方法,API的分类,进程内调用API调用本地开发库本地进程间调用APILinuxIPCAndroidIPC远程调用API内网API企业内网中的API外网API面向互联网的API外网应用内部API外网公共API,什么是RESTfulAPI？,符合REST架构风格要求的API通常基于HTTP实现将HTTP作为一种应用协议，而不是作为传输协议来使用Fielding在其博士论文的第6章中，明确指出“HTTP不是一种传输协议”SOAP将HTTP作为传输协议来使用，是一种非常低效的用法将HTTP翻译为“超文本传输协议”是中国技术翻译史上的一大误译RESTAPIsmustbehypertext-driven!又称作“使用超媒体作为应用状态的引擎”（HATEOAS）,Richardson成熟度模型,Richardson成熟度模型,第0级：没有明确的资源概念，只有一个URL，只使用单个HTTP方法第1级：有明确的资源概念，存在很多URL，只使用单个HTTP方法第2级：有明确的资源概念，存在很多URL，使用HTTP作为操作资源的统一接口通常将对于资源的CRUD式操作分别映射到4个HTTP方法第3级：在满足第2级标准的基础上，使用超媒体作为应用状态的引擎（HATEOAS）,什么是WebAPI？,什么是WebAPI？,一种新式的API类型，通常面向互联网主要用来实现外网公共API&外网应用内部API在一些场合也可以用来实现内网API与传统的WebServices完全不同一种新式的API设计方法最大限度利用HTTP协议将HTTP协议当作应用协议，而不是传输协议来使用使用HTTP协议作为操作资源的统一接口可以透明升级到HTTP/2使用超媒体作为应用状态的引擎（HATEOAS）RESTfulAPI的高级形式,WebAPI是最高等级的RESTfulAPI,完全实现了REST架构风格的四个价值主张可伸缩性安全性松耦合简单性主要是针对客户端应用开发者可以统一不同种类API的设计风格，降低了客户端应用开发者的学习和开发成本拥抱Web原生的架构设计原则拥抱REST拥抱超媒体接受失控，而不是企图控制一切，坦然接受不完美,RESTfulAPI只达到第2级有什么问题？,仍然是紧耦合的依赖固定的URL结构依赖固定的调用方式依赖服务描述文档难以做较大改动交互的粒度仍然很小CRUD式服务仅仅适用于简单的业务建模难以实现复杂的业务操作协议不得不将版本号加入到URL以解决升级问题导致了API数量的膨胀,HATEOAS是否是值得追求的？,优势解决了RESTfulAPI仅仅达到第2级存在的所有问题实现了REST架构风格的所有价值主张劣势对于服务器端应用开发人员而言，设计较为复杂在API设计上多花一些时间，在维护上少花很多时间在API设计上少花一些时间，在维护上多花很多时间是否值得，主要取决于对松耦合、大粒度交互的需求强度，可开展ROI分析,设计良好的WebAPI很像是一个网站,WebAPI与Web应用的类比,都使用HTTP协议来与服务器交互都使用超媒体作为资源表述的格式Web应用使用面向人类的超媒体HTML，资源的表述对应Web页面WebAPI使用面向机器的超媒体AtomPub、Odata、HAL、Collection+JSON、Hydra资源的表述对应HTTP响应的body都需要理解超文本的语义Web应用依靠人类阅读超文本的描述文字来理解其语义WebAPI依靠机器解析超文本的语义标记来理解其语义资源的表述之间都应该通过超文本相互链接起来不应该出现完全孤立的资源表述,WebAPI中两种不同范畴的语义,协议语义：protocolaffordances使用HTTP协议如何与超媒体控件交互应该包括在媒体类型中，例如Hydra无需编写人类可读的文档并非特定于某个业务领域可以开发通用的客户端库和测试工具来处理应用语义：applicationaffordances某个超媒体控件的含义是什么，与其交互可以得到什么结果需要编写人类可读的文档，又名profile特定于某个业务领域,应用语义与词汇表,应用语义是由人类可读的profile文档来描述首先应保证人类可读，机器可读不是必须的应用语义的基本组成元素语义描述符词汇表是语义描述符的汇总常用的词汇表：/GoodRelations：http:/www.heppnetz.de/ontologies/goodrelations/v1应尽量选择使用常用词汇表中定义的通用语义描述符：例如在线购物、在线图片库、微博等等,什么是Hydra？,什么是Hydra？,全名Hypermedia-DrivenWebAPIs一套规范和相关的技术，用来简化设计开发支持HATEOAS的WebAPIHydraCoreVocabulary规范：http:/www.hydra-,SpringHATEOAS介绍,http:/projects.spring.io/spring-hateoas/,可参考的开源项目,hydra-java：,WebAPI设计步骤,Amundsen七步设计法1.罗列语义描述符2.画应用状态图3.调整命名4.选择一种媒体类型5.编写profile6.实现7.发布,WebAPI设计步骤,简化过的五步设计法1.罗列语义描述符2.画应用状态图3.调整命名4.实现（基于Hydra）5.发布,画应用状态图的例子,WebAPI中的可变与不可变,可变可以删除已发布的某个资源可以修改资源的URL可以改变资源上可执行的操作（GET/POST/PUT/DELETE）可以改变资源表述的内容不可变已经发布的应用语义和语义描述符应长期保持不变（向后兼容）,WebAPI设计最佳实践,分离协议语义和应用语义认真画好应用状态图方框：资源的表述连接线：一次应用状态迁移（一次HTTP调用）连接线上的文字：语义描述符优先使用通用的语义GoodRelations基于某种超媒体类型（例如Hydra）开发通用的客户端库,WebAPI能解决的问题,松耦合不依赖固定的URL结构不依赖固定的调用方式易于改动和升级统一的设计风格降低了客户端应用开发人员的学习成本易于实现通用的客户端库支持更大粒度的交互开发人员不容易混淆远程调用与本地调用会改善用户可感知的性能,WebAPI能解决的问题,支持数据流和管道易于实现分层的缓存，提高了服务器端应用的可伸缩性最好的互操作性基于HTTP协议，几乎所有编程语言都支持易于跨越组织的边界实现API的集成,WebAPI不能解决的问题,不支持有状态的长连接，无法进行双向通信，实时性较差让服务器端应用开发人员早点下班把轻松留给客户端应用开发人员，把困难留给自己佛祖把困难留给客户端应用开发人员，把轻松留给自己人渣设计开发领域模型DDD是设计开发领域模型的利器DDD与WebAPI是互补的关系，可相互支持,WebAPI服务器端开发人员的利益,可以自由添加新的资源表述（联想到为网站添加新的页面），并且把新增资源表述与已有资源表述链接起来，即：定义新的应用状态迁移（资源链接的语义描述符）。可以改变某个已有资源的URL地址。可以为某个已有应用状态迁移（一次HTTP请求）添加新的请求参数。新增参数不是必需的。可以为某个已有应用状态迁移（一次HTTP请求）删除不是必需的请求参数。可以为某个已有应用状态迁移（一次HTTP请求）添加新的响应参数。新增参数不是必需的。可以为某个已有应用状态迁移（一次HTTP请求）删除不是必需的响应参数。可以充分利用各级别的HTTP缓存，改善可伸缩性。,WebAPI客户端开发人员的利益,只需要理解应用的语义（定义在profile文档中），不需要假设某个资源一定存在，URL一定是某种格式。除了入口URL，不再依赖服务器端的固定URL，不必再自己构造URL。可以开发理解HTTP协议语义的通用库来简化客户端开发。提高了健壮性，当服务器端API升级时，只要已经发布的应用语义和应用状态迁移保持不变，客户端应用就不会崩溃。可以自由探索服务器端新增的功能（应用状态迁移），根据服务器端新增功能加强客户端功能。可以实现更大粒度的交互。可以基于统一的风格来调用服务器端API，降低了学习和开发成本。,未来的展望,HydraCoreVocabulary成为正式的Web标准出现更多针对特定领域的词汇表基于Hydra开发通用的客户端库支持Hydra的自动化测试工具WebAPI与微服务的结合WebAPI与DDD的结合,WebAPI名人堂,TimBerners-Lee,RoyT.Fielding,StefanTilkov,WebAPI名人堂,JimWebber,MikeAmundsen,MarkusLanthaler,参考图书资料,REST实战，JimWebber,SavasParastatidis,IanRobinson合著RESTfulWebServicesCookbook中文版，SubbuAllamaraju著RESTfulWebAPIs中文版，LeonardRichardson,MikeAmundsen合著RESTfulWebClients中文版（今