0

我正在用 PHP 构建一个接受 JSON 作为其有效负载的 RESTful Web 服务。现在，我的问题是，我如何准确地向用户描述 JSON 请求的格式？我是 JSON 新手，我认为我没有 100% 掌握。

其他用户系统基本上会使用我需要的键值对创建一个数据结构（如数组），将其编码为 JSON 并将其发送到我的 Web 服务吗？

我是否真的给他们一份阵列需要看起来的副本？谢谢！

4

2 回答 2

1

遵循 REST 准则，您从 API 用户获得的输入应该是 URL 的一部分（对于 GET 请求；不更新数据，即http://example.com/api/doc/1243），或者应该是 POST 变量（在正文中发送） HTTP 请求，发送到相同的 URL）。

因此，对于文档，您需要做的就是指出端点 URL ( http://example.com/api/doc/1243)、它们需要使用 POST 的事实以及变量是什么（即title、body、author等）。然后用户将根据他们的需要形成正确的 HTTP 请求，并且在您的服务器端，因为您使用的是 PHP，您将从$_POST数组中提取他们的变量（即$_POST['title'],$_POST['body']等）

于 2012-09-26T12:14:48.513 回答
1

Dropbox是使用 JSON 作为有效负载的 restful api 的一个很好的例子。

您还将很好地了解如何记录您的 API。

于 2012-09-26T12:31:37.613 回答