一个有据可查的RESTful服务的例子
我需要编写一个RESTful服务的文档。 有没有人知道一个很好的RESTful服务的文档，在那里我可以用作我自己的模板？
谢谢。
请查阅REST API文档最佳实践文档以logging您的RESTful服务。 该文件涵盖了所有方面。 这是它的一个片段。
标题：显示所有用户。
URL： / users或/ users /：id或/ users？id =：id
方法： GET | POST | 删除| 放
URL参数：Required:id = [整数]或Optional:photo_id = [字母数字]
数据参数： {u：{email：[string]，name：[string]，current_password：[alphanumeric]密码：[alphanumeric]，password_confirmation：[字母数字]}}
响应代码：成功（200 OK），错误请求（400），未经授权（401）
你有没有听说过http://swagger.io/ ？ 它为REST API生成一个非常有用的（和很好的）文档。
试一试。 我真的推荐它。
你可以参考Zoho订阅API文档。 这3列布局文件是由资源明智的结构，并具有示例请求和每个端点的响应。
披露：我是Zoho Subscriptions团队的一员。
Twitter Api文档是我遇到的最好的。
CouchDB的API是 “RESTful数据库”。
您会注意到文档是由资源而不是由方法构build的，使得它比大多数众所周知的API文档更加面向资源。
尝试rest工具 。
它遵循一个语言不可知的方法来编写规范。 为现成的RESTful API提供即时模拟实现和自动化unit testing。
这些服务是通过YAML文件指定的，样本数据可以放在描述符的旁边。 您可以find一个JSON模式，以确定service.yml描述符文件的格式。 这可以作为一个guilde，但它可以根据需要扩展。
可读性API最近在Twitter上受到好评。
披露：我是Arc90的参与者，Readability的创造者，Readability的投资者。
