1. 对于返回的Json对象格式是以“帕斯卡”风格的（例如“FirstName”），然而我们的Api有很大的可能被带有Javascript的客户端消费，对于JS开发者来说可能更适合“驼峰”风格（例如”firstName”）的数据。解决方案：配置Json格式。
Web Api提供Xml和JSON作为返回数据的格式，框架会自动把这些格式注入管线。客户端可以通过Http请求头部来声明需要的数据格式，我们可以通过在“WebApiConfig”这个类来配置JSON数据的格式：
public static class WebApiConfig { public static void Register(HttpConfiguration config) { // Web API configuration and services var json = config.Formatters.JsonFormatter; // 解决json序列化时的循环引用问题 json.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore; // 干掉XML序列化器 config.Formatters.Remove(config.Formatters.XmlFormatter); var jsonFormatter = config.Formatters.OfType<JsonMediaTypeFormatter>().First(); jsonFormatter.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver(); // Web API routes config.MapHttpAttributeRoutes(); config.Routes.MapHttpRoute( name: "DefaultApi", routeTemplate: "api/{controller}/{id}", defaults: new {id = RouteParameter.Optional} ); } }
首先根据HttpConfiguration对象获得jsonFormatter对象，然后设置ContractResolver属性。那么以后当我们使用JSON数据格式的时候就是“Camel”风格的了。
2. 对于返回单个资源，我们应当返回相应的状态码（例如：成功200，资源未找到404等），解决方案：HttpResponseMessage对象
Web Api框架中有一个”HttpResponseMessage“类可以用来返回Http状态码。有的时候使用状态码代替model来响应给客户端会更好
public HttpResponseMessage GetCourse(int id) { try { var course = TheRepository.GetCourse(id); if (course != null) { return Request.CreateResponse(HttpStatusCode.OK, TheModelFactory.Create(course)); } else { return Request.CreateResponse(HttpStatusCode.NotFound); } } catch (Exception ex) { return Request.CreateErrorResponse(HttpStatusCode.BadRequest, ex); } }
ASP.NET Web API 配置返回的json字段的格式以及Action返回HttpResponseMessage类型,布布扣,bubuko.com
ASP.NET Web API 配置返回的json字段的格式以及Action返回HttpResponseMessage类型