RESTful API中的RPC响应格式

Question

我正在设计API并尝试坚持使用json-api作为输出格式。我需要提供一个服务端点，如：resource/1/do-something-complicated。我想知道是否有任何最佳实践的响应格式发送到这种请求，因为它没有在资源＆＃34;上做传统的CRUD。不需要特定于json-api。只是想知道。

Answer 1

规范网站似乎对asynchronous processing提出了一些模糊的建议。这看起来归结为POST /resource和202 Accepted的响应，然后是Content-Location标题，以查看状态。有效载荷本身根本没有描述。

我会尝试在您的POST有效负载上接受/resource，例如

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

然后返回一个用于检查作业状态的URL。