用 WCF 创建一个 REST 的 API

  • Hartmut Wilms
  • 张逸

2008 年 3 月 18 日

话题:SOA.NETREST语言 & 开发架构

Aaron Sloman 和 Haider Sabri 在MIX08中谈到了如何“使用 WCF 创建一个 REST 的 API”,其中,介绍了一个名为RESTChess的 REST 应用程序示例。

Aaron Sloman 首先谈到在 WCF 中支持 REST 的某些背景信息。接着,Haider Sabri 则对 REST 以及 REST 的主要特性进行了简要的介绍。据 Haider 所说,REST 提供的关键优势在于:

    • 低的学习门槛
    • ROA 遵循了 Web 语义……适于 Web 服务的 APIs
    • 灵活多变的响应格式

他认为“如果客户端未知,那么在创建一个通用 API 时,REST 是最佳选择”。

WCF 通过Web 编程模型来支持 REST,该模型是在.NET Framework 3.5 中增加的,包括如下概念:

  • URI Templates & WebGet/WebInvoke
    • 它们都是特性,用于映射 HTTP 请求到类中的方法。
  • WebHttpBinding
    • WebHttpBinding 是 WCF 的一个绑定,允许 WCF 基于 WebHttp 进行内容发送。
    • 你可以很容易地在 REST 和 SOAP 的 API 之间进行切换。
  • WebOperationContext
    • WebOperationContext 支持以 REST 方式处理请求与响应。

Haider Sabri 介绍了RESTChess,它是用于国际象棋游戏的 REST 的 API。RESTChess 既是一个很好的例子,用来展现采用 WCF 的 Web 编程模型实现的 REST 的 API,同时又是一个扩展集(定制 WCF 绑定和行为),弥补了 WCF Web 编程模型的缺陷:

  • 灵活的 URIs
    • 在 IIS 托管服务时,服务的.svc 扩展名是必备的。
    • RESTChess 提供了一个 URL 的重写器,并在 IIS 7 中被实现为一个 HTTP 模块。
  • 为只支持 GET 和 POST 的低级 REST 客户端搭建支撑的桥梁
    • 有两种常见的方法可以解决这一问题:
      • 自定义 HTTP 标头
      • _method 查询参数
    • RESTChess 实现了一个自定义 WCF 通道,可以分辨高级的和低级的 REST 客户端,以及修改利用隐藏的 DELETE 或 PUT 方法通过 POST 请求传递到适合的 HTTP 方法的消息。
  • 使用数据签名验证请求

    • RESTChess 使用了OAuth,它是一个包含了数据签名的“支持安全的 API 验证的开放协议”。
    • OAuth 调用者作为查询参数对签名进行传递。
    • 一个自定义的 WCF 通道负责检查请求是否具有 OAuth 密钥,如果在请求被分发给服务模型之前,调用者没有被验证(密钥不存在或者不能识别),就会抛出一个异常。
  • 多种表现形式
    • WCF 只支持 XML 和 JSON。
  • REST 的异常处理
    • RESTChess 团队构建了一个引擎,能够将异常映射到适当的 HTTP 错误代码。

虽然该团队为 WCF 的 Web 编程模型完成了拾遗补阙的任务,但 Haider 则认为:“WCF 的闪光之处就在于能够对它进行扩展、添加,以及构建在高水平的基础之上”。

查看英文原文:Creating a RESTful API with WCF

SOA.NETREST语言 & 开发架构