提示:随着RESTful Web services的流行程度不断地上升,开发人员需要知道如何避免开发中的陷阱以及让开发出来的Web service达到自己能做到的最好程度。
过去的几年里,我们看到RESTful Web services变得流行起来是有好些原因的。这里有十个技巧你应该要做的,它们能让你的RESTful Web Service更加高水准并且被其他开发人员使用起来更加简易。
- 不要寻找一个官方的“REST 标准”
REST是一个概念,不是一个标准。因此没有任何的要求让你的 RESTful Web service在一个特定的方式下运行。话虽如此,但......
- 还是坚持一些标准
......你的 RESTful Web services 应该遵循至少一些标准!例如用户认证的OAuth协议、数据交换的JSON和XML、网络传输和自控制的HTTP协议还有URI标准。如果你想要一个更加完整的包,开放数据协议OData是一个有效的选择(因为它够大?)。因为没有人说“REST必须坚持这些标准”这样的话,并不意味着你就应该按照自己的意愿来。
- 确保你的文档是完美无瑕疵的
使用 SOAP 协议的WSDL(Web Service 定义语言)系统,如果你有一个基于WSDL、可以自动生成代码的工具,那么开发Web Service是相当简单的。但如果用 REST ,由于services不需要严格的定义,并且它们运行在被称为适当地正确工作的理念上。这意味着service的文档必须要非常严谨。如果你要开发一个Web Service一定要确保你的文档百分百的正确。
- 提供 JSON 输出
JSON 已经迅速的变成web上的重要标准。首先,它很方便,因为它可以很容易地让JavaScript以最少的编码量来使用Web Service。现在有很多库可以让服务端与客户端的JSON交互工作的非常好。
- 不要漏掉 XML
说到输出,XML 依然像往常一样非常重要。为什么要同时支持 XML 和 JSON 呢?因为并不是所有的系统都能使用 JSON 的,但如果一个系统能被称为 Web Service ,那么它就一定会被规定去处理XML。现在有成堆的遗留系统,举个例子,它是用XML工作而不是JSON。并且不是所有开发人员都想去mixing和匹配JSON跟XML的。因此要确保你的Web service系统支持这两种格式。通过HTTP请求头的“Accepts”参数来做这种支持而不是通过不同的包含参数的 service URL 来做。
- 理解 HTTP 动词
REST Web services 其中一个很核心关键的是HTTP协议已经定义好的一大块功能。而这其中最基本的一部分就是 HTTP 动词,例如 GET、POST 。而这些基本功能在REST中已经被很好地、充分地理解,一些想法仍然不断地涌现,例如使用打补丁的方式更新实体中一些特定属性而不是整个实体。
- 理解 URI 路由的重要性
RESTful Web services 在很大程度上是通过URI来决定干什么的。举个例子,在一次 GET 请求中,典型的URI路径会包含一个实体的主键值(或者其他标识键值)来检索获取实体的数据。例如 “http://www.example.com/service/entityname/76″ 将检索名字为 entityname, 主键值为 76 的实体。使用 REST Web services,URI 不仅是一种访问service的方式,还是控制service和作为传达你的需求的信号载体。
- 在版本管理下进行更新维护
一件很诱人的事是你只需对唯一一个版本的service做更新维护。但真的不要这样做!确保你每一次发布更新后都新开一个分支版本来维护。最简单、最常见的办法是让你的service URI 带上版本号,通常是路径的一部分。人们最需要的一件事就是使用更新后的软件没有任何新的问题或警告出现。
- 与你的用户保持联系
因为用户不会主动发现你的更新,因此你和你的用户保持联系就显得十分重要了。例如,当你为你的service发布一个新的版本时,你应该给每一个用户发一封邮件让他们知道,以及提供旧版本的缺陷信息。
- 提供示例代码
对你的用户来说你要做的最好的一件事之一就是给他们提供示例代码。确保你给出的代码至少包含以下几个主要的开发语言:Java、.NET、JavaScript、Ruby还有Python。如果有必要的话,雇佣一个顾问将这些代码放在一起。因为它对于你的 service 能否被采用是绝对重要的。还要确保你的许可协议可以让你的用户没有任何风险影响地使用你的示例代码,例如可以使用 MIT 或 BSD 许可协议。
分享到:
相关推荐
- **主要内容**:本书深入探讨了REST(Representational State Transfer)风格的Web服务设计与实现方法,通过一系列实用的示例和技巧来帮助读者掌握如何构建高效、可扩展且易于维护的RESTful Web服务。 #### 描述:...
RESTful Web Service是...通过阅读这本书并结合实际项目练习,你可以掌握创建高效、可维护的RESTful Web服务的技能。RESTful风格不仅简化了服务设计,还提高了服务的互操作性和可发现性,是现代Web开发的重要组成部分。
总之,《REST开发者RESTful资源指南》是一份非常有价值的参考资料,无论是对于REST新手还是经验丰富的开发者来说,都能够从中获得宝贵的见解和实用的技巧。通过深入理解REST的核心理念和技术细节,开发者可以更加...
【Web服务实用培训教程】 Web服务是现代互联网技术的重要组成部分,尤其在ASP.NET 3.5框架中,它被进一步强化并广泛应用于各种场景。Web服务允许不同平台、不同应用程序之间的无缝交互,通过HTTP协议使用XML作为...
JAX-RS(Java API for RESTful Web Services)是一个Java标准,它简化并促进了RESTful Web服务的开发。JAX-RS 2.0作为该标准的更新版本,引入了新的注解和方法来支持RESTful服务的构建。从定义资源到处理HTTP请求,...
该书通常会涵盖以下内容: Web 服务概述: 介绍什么是 Web 服务以及它们在现代 Web 开发中的作用和应用场景。 PHP 简介: 介绍 PHP 编程语言...性能优化和调试: 提供优化 Web 服务性能和调试技巧的实用建议和方法。
在本篇文章中,我们将详细讲解Delphi在Web开发中的应用,以及一些实用的技巧。 首先,Delphi提供了多种框架和库用于Web开发,例如Indy、WebBroker、FireDAC等。Indy是一个流行的网络组件库,它包含了处理HTTP、FTP...
Java Web服务是基于开放标准的、平台无关的通信机制,...这本书可能涵盖了Web服务的基础知识,高级特性,甚至包括一些实用技巧和最佳实践。通过学习这本书,你可以系统地掌握Java环境下开发Web服务的核心技术和工具。
10. 性能优化和故障诊断:性能是Web服务长期稳定运行的关键,本书涉及优化Web服务性能的技巧和故障诊断的方法。 由于本书版权归属于Packt Publishing,因此我们不提供下载链接和内容的复制。如果读者想要获取此书的...
压缩包中的“Web开发实用软件.ppt”很可能是一个PowerPoint演示文稿,详细列举了上述的一些工具,并可能包含了使用技巧、配置示例或对比分析。通过阅读这份文档,你可以深入了解并掌握更多的Web开发工具,从而提升...
【标题】:“实战Web Service —— 使用Apache CXF开发Web服务的教程” 【内容详解】: ...通过本教程,你将能够掌握使用Apache CXF开发Web服务的基本流程和技巧,为后续的Web服务项目打下坚实基础。
《基于ASP.NET的Web应用开发技术实用教程》涵盖了ASP.NET框架下的核心开发概念和技术,是学习Web应用程序构建的宝贵资源。教程中包含了多个项目源代码,这些项目分别为“项目1”到“项目7”,旨在帮助读者通过实际...
WebAPI支持Area是一种在ASP.NET Web API框架中组织和管理大型项目中路由和控制器的有效方法。Area的概念源自ASP.NET MVC,它允许将大型应用...这是一个非常实用的技巧,对于构建大型、复杂的企业级API服务非常有帮助。
标题中的“一个TypeScript JavaScript包的集合,用来构建高质量的web服务”暗示了这个压缩包包含了一系列用于构建高效、高质量Web应用的资源,主要聚焦在TypeScript和JavaScript这两个编程语言上。TypeScript是...
"PowerBuilder 102个绝对实用技巧"这个资源很可能涵盖了以上所述及更多实际操作中的技巧,每个技巧都值得开发者深入研究和实践。通过学习和应用这些技巧,开发者能够更高效、更专业地使用PowerBuilder进行企业级应用...
最后,文档提到了一些Web安全测试的实战技巧,例如,如何通过检查网站的robots.txt文件、 favicon.ico文件、寻找网站的管理页面、生成错误信息以及构建一些实用的工具来辅助测试等。这些技巧能够帮助渗透测试人员更...
该书旨在揭示Java技术在构建Web应用程序中的精华与技巧,为开发者提供全面、实用的指导。从标题和描述中,我们可以提炼出几个关键的知识点: 1. **Java Web开发基础**:本书涵盖了Java Web开发的基础概念,包括...