正确返回Web API

Question

return new ObjectResult(person); 
return NotFound(); // NotFound() is framework function - returns 404

Answer 1

正确的REST方法是返回HTTP404状态代码。

Person是API上下文中的一个资源，所以应该没问题。REST客户端和开发人员知道如何处理HTTP错误，404错误非常有意义。

你可以在404回复体中写一个理由，但我不介意。

public class ApiResponse {
    // I use lowercase properties so that the JSON follows common JavaScript naming conventions
    public bool success { get; set; }
    public String errorMessage { get; set; }
    public int? errorCode { get; set; }
}

public class GetPersonResponse : ApiResponse {
    public PersonModel person { get; set; }
}

public GetPersonResponse Person(string id) {
    var person = FindPersonByName(id);
    var response = new GetPersonResponse {
        success = person != null,
        person = person
    }
    if (person == null) {
        response.errorCode = 404, // suggestion only
        response.errorMessage = "Person not found"
    }        
    return response;
}