使用json-home的API主文档

时间:2014-06-13 12:15:00

标签: json api rest web

我正在用PHP开发一个小型的web api,尽量让它变得更加安静。 目前我正在开展一些主页"这应该是一个json代表客户端可以做什么而不必阅读文档的概述。我发现json-home格式(参见draft-nottingham-json-home-02)在我的案例中似乎非常有用。但由于它没有传播那么多,很难找到例子。我不明白的是" href-vars" - 属性是(见4.1. Resolving Templated Links)。

例如我有一个路由/ api / documents / {id}什么给了我一个单个文档的json表示。显然这是json-home格式的模板链接资源,但是我的href-vars:{id:}?

1 个答案:

答案 0 :(得分:0)

HREF-VARS用于指定URL模板的参数。 URI首先是参数的唯一标识符。 URL 可以包含有关参数类型的文档。