rest - REST/HATEOAS API 的入口点？

Question

我已经开始设计 API 并决定尝试使其符合 REST/HATEOAS。 API 的入口点应该是什么？

似乎常见的是GET /但从我读过的内容来看，使用 OPTIONS / 在逻辑上可能更有意义。 ，因为在 / 实际上没有资源用于检索。

我在这里给出了两者的例子，使用 HAL JSON 作为超媒体格式的语法。

得到/

请求:

GET / HTTP/1.1
Host: example.com

回复:

HTTP/1.1 200 OK
Date: …
Content-Type: application/json;charset=utf-8
Content-Length: 143

{
    "_links": {
        "self": {
            "href": "/"
        },
        "penguins": {
            "href": "/penguins"
        }
    }
}

选项/

请求:

OPTIONS / HTTP/1.1
Host: example.com

回复:

HTTP/1.1 200 OK
Date: …
Allow: OPTIONS
Content-Type: application/json;charset=utf-8
Content-Length: 143

{
    "_links": {
        "self": {
            "href": "/"
        },
        "penguins": {
            "href": "/penguins"
        }
    }
}

Answer 1

对 OPTIONS 的回应request 仅描述您请求的资源的选项，即 / .通常向 GET / 提供更多信息然后让响应正文中每个链接的链接关系告诉您可以对链接的资源采取哪些操作。

此外，回复 OPTIONS不可缓存，这可能非常重要，尤其是在涉及链接菜单等静态内容时。