关于使用JSON:API规范创建或更新资源时传递“字段”和“包含”之类的URL参数的建议

时间:2019-08-27 02:50:32

标签: json-api

在这种情况下,我将使用'includes'和'fields'参数获取资源以获取特定的响应(已在客户端标准化)。我想做的是更新资源或创建新资源,但响应以与GET请求中的资源相同的格式返回。如果允许的话,我认为这样做的方法是像在GET请求中一样,在PATCH或POST请求的URL中传递“ includes”和“ fields”参数。但是,我在https://jsonapi.org/上没有提到这种情况,因此我很好奇这种情况是否可以接受或禁止,并且对这里的最佳做法感到好奇。

1 个答案:

答案 0 :(得分:2)

使用主数据进行响应的任何端点都支持使用included查询参数和稀疏字段集来请求包含相关资源。规范中均在相关章节中明确提到了这一点:

  

包含相关资源

     

[...]

     

注意:本节适用于任何以原始数据进行响应的端点,而与请求类型无关。例如,服务器可以支持包含相关资源以及POST请求以创建资源或关系。

     

https://jsonapi.org/format/#fetching-includes

     

稀疏字段集

     

[...]

     

注意:本节适用于任何以资源作为主要数据或包含数据进行响应的端点,而与请求类型无关。例如,服务器可以支持稀疏字段集以及POST请求以创建资源。

     

https://jsonapi.org/format/#fetching-sparse-fieldsets