Should the PATCH method return all fields of the resource in the response body?

后端 未结 3 1609
南笙
南笙 2021-02-02 10:53

Should the PATCH method return all fields of the resource in the response body?
Or should it return only updated fields?

I\'m reading this

For example, i

3条回答
  •  灰色年华
    2021-02-02 11:22

    Normally this should be handled through content negotiation. In other words, the client asks for a specific representation if it needs one. The request would look like this:

    PATCH /user/123
    Content-Type: application/merge-patch+json
    Accept: application/vnd.company.user+json
    ...
    

    In this case, the client expresses that it wants a full user representation as answer. Or it could do:

    PATCH /user/123
    Content-Type: application/merge-patch+json
    Accept: application/vnd.company.object-fragment+json
    ...
    

    to ask for a generic fragment representation of some object.

    You don't have to implement both if you don't want to, in which case you just do your use-case and respond with 406 Not Acceptable to media-types you do not support for the moment.

提交回复
热议问题