任何人都有一个“定义良好”的REST Web服务的例子？

Question

我阅读了关于REST与SOAP辩论的大量帖子，问题和答案。我读了一些REST支持者，声称“设计良好”的REST Web服务是自我解释的，几乎不需要任何文档。

有人能指点我这样的网络服务吗？优选地是稍微复杂的一个。

Answer 1

用于网络摄像机的复杂API的

Here is an example ...我建议查看VAPIX HTTP 3.0 API。假设您熟悉这些术语，则可以非常直接地遵循。当然，它大约有60页，但其中大部分只是让读者熟悉使用网络API的样板。

Yahoo! Weather Feeds是从服务中提取信息的简单RESTful方式的示例。

还有REST API的示例，它们本质上来回发送XML结构化数据。虽然这些在技术上是REST，但如果您在使用XML定义API时遇到麻烦，我会考虑使用web services。

Answer 2

我发现Netflix's文档非常好，可以帮助您了解设计API的过程。 API并不完美，但我认为它是实用和周到的完美结合。

自我记录REST API的想法是，可以为系统提供一个入口点，并且能够通过返回的文档发现所有可用的功能，并结合对REST动词的标准用法的理解（GET， PUT，DELETE）。因此，如果您从RESTful系统中提取员工列表，则各个条目将指向该条目的URL，而雇主字段将指向雇主的URL。在HATEOAS上搜索以获取更多详细信息。但您可以在服务上调用“/ employee”并获取：

<employees>
  <employee id=132 name=bob url="/employee/132" employer="/employer/176"/>
  <employee id=179 name=carl url="/employee/132" employer="/employer/122"/>
</employees>

您可以在/ employee / 132查看完整的员工记录，并在/ employer / 176查看其雇主的记录。按照惯例，如果您有权限，则可以使用针对/ employee / 132的PUT更新员工bob，或者创建一个带有POST给/ employee的新员工。接受的内容类型也可以通过界面查询（我相信使用HEAD）。

Answer 3

查看Amazon S3。