使用 json-home 的 API 主文档

Question

我正在用 PHP 开发一个小型 Web API，并尝试使其尽可能安静。 目前我正在开发某种“主页”，它应该是一个 JSON 表示的概述，说明客户端无需阅读文档即可执行的操作。我发现了 json-home 格式（参见 draft-nottingham-json-home-02），这对我来说似乎非常有用。但由于它传播得并不广泛，因此很难找到例子。我不明白的是“href-vars”属性是什么（请参阅4.1.解析模板化链接）。

例如，我有一条路线 /api/documents/{id} ，它为我提供了单个文档的 JSON 表示形式。显然这是一个 json-home 格式的模板链接资源，但是我的 href-vars : { id: } 是什么？

Answer 1

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