使用json home的API home文档

我正在用PHP开发一个小型web api，并尝试使其尽可能具有restful。 目前，我正在开发某种主页，它应该是一个json表示的概述，说明客户端可以做什么，而不必阅读文档。我发现了json home格式，看看在我的例子中什么似乎非常有用。但由于它没有传播那么多，很难找到例子。我不明白的是href vars-属性是什么

---

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

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