1. 首页
  2. 问答
  3. 有据可查的RESTful服务示例

有据可查的RESTful服务示例

2011-02-08 31 views
55

我需要编写RESTful服务的文档。有没有人知道一个非常好的RESTful服务文档，我可以使用它作为我自己的模板？有据可查的RESTful服务示例

谢谢。

来源

2011-02-08 Pablo

+1

你找到一个？如果你有这个问题，我很有兴趣知道哪一个。 – 2013-11-11 09:37:16

+4

REST风格的服务不需要很好的书面文档。 :) – 2014-03-01 23:36:57

+9

每个API都需要很好的书面文档 – kralco626 2015-11-19 14:33:25

回答

0

Readability API最近在Twitter上受到好评。

披露：我是Arc90的成员，Readability的创造者和Readability的投资人。

来源

2011-02-08 21:00:52

2

API of CouchDB“这个”RESTful数据库。

你会注意到文档是由资源而不是由方法构造的，使得它比大多数众所周知的API文档更加面向资源。

来源

2014-01-16 06:43:00

1

尝试rest-tool。

它遵循语言不可知的方法来编写规范。为现成的RESTful API提供即时模拟实现和自动化单元测试。

服务通过YAML文件指定，示例数据可以放在描述符旁边。您可以找到一个JSON模式，以符合service.yml描述符文件的格式。这可以作为一个guilde使用，但它可以根据需要扩展。

来源

2014-03-01 10:32:54 tombenke

12

您可以参考Zoho Subscriptions API文档。这3列布局文档由资源明智地构成，并为每个端点提供样本请求和响应。

披露：我是Zoho Subscriptions团队的一员。

来源

2014-10-28 07:10:13

13

您是否听说过http://swagger.io/？它为REST API生成非常有用的（和很好的）文档。

试试看。我真的推荐它。

来源

2015-07-23 22:30:08

44

请检查REST API Documentation Best Practices文档以记录您的RESTful服务。该文件涵盖了所有方面。这是它的一个片段。

标题：显示所有用户。
网址： /或用户/用户/：ID或/用户ID =：ID
方法： GET | POST |删除| PUT
网址参数：Required: ID = [整数]或者Optional: photo_id = [字母]
数据PARAMS： {U：{电子邮件：[字符串]名称：[字符串]，current_password：[字母数字]密码：[字母]，password_confirmation：[字母]}}
响应码：成功（200 OK），错误请求（400），未经授权（401）

来源

2015-09-07 14:06:13 YoungHobbit

相关问题

 相关问题