当属性不存在时，在REST JSON API上POST / PUT

Question

We are building public RESTful JSON API and trying to figure out what is the best practice for POST/PUT requests when specified property doesn't exist. Should we throw an HTTP error and which one or just skip it and apply all other properties?

{
    "name" : "Test",
    "property_doesnt_exist" : "that's sad"
}

Answer 1

HTTP 422: Unprocessable Entity

The 422 (Unprocessable Entity) status code means the server understands the content type of the request entity (hence a 415 (Unsupported Media Type) status code is inappropriate), and the syntax of the request entity is correct (thus a 400 (Bad Request) status code is inappropriate) but was unable to process the contained instructions. For example, this error condition may occur if an XML request body contains well-formed (ie, syntactically correct), but semantically erroneous, XML instructions. RFC4918

A common practice is NOT to add valid message properties if the message also contains invalid properties.

Answer 2

A common rule for a server is to be generous in what you accept and strict in what you produce.

I'd prefer to accept such an input and get as much as possible out of it. Any unknown property of the input would be ignored.

Answer 3

When answering that question you have to consider versioning too. Do you support old clients that send fewer arguments than expected - that could work with suitable defaults. Or do you have more than one server implementation such that newer clients would be sending too many arguments for an older server implementation? If the answer is yes to one of these then you have to be careful about rejecting inputs.