RESTful API 中的 RPC 响应格式

Question

我正在设计 API 并尝试坚持使用 json-api 作为输出格式。我需要提供一个服务端点，例如：resource/1/do-something-complicated。我想知道是否有响应格式发送到这种请求的任何最佳实践，因为它不会在 "resource" 上执行传统的 CRUD。不需要 json-api 具体。只是想知道一般情况。

Answer 1

规范网站似乎对 asynchronous processing 有一些模糊的建议。这看起来可以归结为 POST /resource 和 202 Accepted 的响应，然后 Content-Location header 关于检查状态的位置。根本没有描述有效负载本身。

我会尝试在您的 /resource 处接受 POST 等负载，例如

{
    "data": {
        "attributes": {
            "type": "some-complicated-process",
            "id": 1
        }
    }
}

这将 return 一个 url 用于检查作业的状态。

RESTful API 中的 RPC 响应格式

RPC Response format in RESTful API

rest

rpc

restful-architecture

json-api