api - 使用json主页的API主页文档

  显示原文与译文双语对照的内容
0 0

我正在用PHP开发一个小型 Web API,并尽量让它尽可能的rest化。 目前我正在研究一种"主页",它应该是一个表示客户端可以做的概述的。 我发现json主页格式( 请参见 draft-nottingham-json-home-02 ) 在我看来似乎是非常有用的。 但由于它没有传播那么多,所以很难找到例子。 我不明白的是"href var"属性是什么( 请参见 4.1. 解决模板化链接( ) 。

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

时间: 原作者:

0 0

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

原作者:
...