DotNet Web Api開發(fā)Restful Api相關
開發(fā)環(huán)境
- Visual Studio 2015
- .Net Framework 4.5
- Web Api
image
統(tǒng)一返回結果
Restful Api 的返回結果基本上使用的是 JSON 格式化戳，在 .Net Web Api 中默認的是返回 XML 格式，需要修改一下返回的結果的格式
- 統(tǒng)一配置返回
JSON格式
在 WebApiConfig中清除其他的格式新荤，并添加 JSON 格式
config.Formatters.Clear();
config.Formatters.Add(new JsonMediaTypeFormatter());
也可以去除 XML 格式
config.Formatters.Remove(config.Formatters.XmlFormatter);
還可以配置 JSON 數(shù)據(jù)的格式
縮進
var json = GlobalConfiguration.Configuration.Formatters.JsonFormatter;
json.SerializerSettings.Formatting = Newtonsoft.Json.Formatting.Indented;
駝峰式大小寫
var json = GlobalConfiguration.Configuration.Formatters.JsonFormatter;
json.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();
- 自定義返回結果
public static HttpResponseMessage toJson( System.Net.HttpStatusCode code, Result result)
{
var response = Newtonsoft.Json.JsonConvert.SerializeObject(result);
HttpResponseMessage res = new HttpResponseMessage(code);
res.Content = new StringContent(response, Encoding.UTF8, "application/json");
return res;
}
統(tǒng)一的返回結果數(shù)據(jù)格式,對于 null添加注解 [JsonProperty(NullValueHandling = NullValueHandling.Ignore)] 數(shù)據(jù)可以選擇忽略担锤，不返回給客戶端
public class Result
{
/// <summary>
/// 錯誤信息
/// </summary>
[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string err;
/// <summary>
/// 具體的數(shù)據(jù)
/// </summary>
[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public object data;
public Result(string err,object data)
{
this.err = err;
this.data = data;
}
}
- 使用 篩選器
ActionFilterAttribute統(tǒng)一處理返回結果
public class ResultFilterAttribute : ActionFilterAttribute
{
//在Action處理完相關的數(shù)據(jù)之后不翩，會在經(jīng)過這個方法處理
public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
{
if (actionExecutedContext.ActionContext.Response != null)
{
var data = actionExecutedContext.ActionContext.Response.Content.ReadAsAsync<object>().Result;
Result result = new Result(null, data);
HttpResponseMessage message = Utils.toJson(System.Net.HttpStatusCode.OK result);
actionExecutedContext.Response = message;
}
}
}
對應的 Controller或Action 添加對應的注解
[HttpGet]
[ResultFilter]
public IHttpActionResult AllCategory()
{
IEnumerable<CategoryModel> result = _service.GetAllCategory();//具體的數(shù)據(jù)
return Ok(result);
}
參數(shù)檢查驗證
在進行請求接口時齿诞，需要先對提交的數(shù)據(jù)參數(shù)做一些驗證衡便，驗證數(shù)據(jù)的合法性献起，如果不合法就不再通過action，直接返回給客戶端處理镣陕。
使用FluentValidation做參數(shù)驗證
- 配置
FluentValidation
使用Nuget安裝 FluentValidation.WebApi
需要驗證的數(shù)據(jù)model
[Validator(typeof(UserReqValidator))]
public class UserReq
{
public string username;
public string password;
}
public class UserReqValidator : AbstractValidator<UserReq>
{
public UserReqValidator()
{
RuleFor(m => m.username).NotEmpty().NotNull().WithMessage("用戶名不能為空");
RuleFor(m => m.password).NotEmpty().NotNull().MinimumLength(8).WithMessage("密碼不能為空谴餐，長度至少是8位");
}
}
讓 FluentValidation 生效，在 WebApiConfig中添加如下配置
public static class WebApiConfig
{
public static void Register(HttpConfiguration config)
{
...
FluentValidationModelValidatorProvider.Configure(config);
}
}
- 請求驗證
public class ParamsFilterAttribute : ActionFilterAttribute
{
public override void OnActionExecuting(HttpActionContext actionContext)
{
if (!actionContext.ModelState.IsValid)
{
var result = new Result("參數(shù)非法", null);
actionContext.Response = Utils.toJson(System.Net.HttpStatusCode.BadRequest, result);
}
}
}
對應的 Controller或Action 添加對應的注解,如果參數(shù)請求的參數(shù)非法呆抑，就會直接返回給客戶端岂嗓，就不會在經(jīng)過對用的Action
[HttpPost]
[ParamsFilter]
[ResultFilter]
public IHttpActionResult CategoryLevel([FromBody] UserReq req)
{
var ids = _service.GetQuestionIdsByLevel(req);
var result = _questionService.GetQuestionByIds(ids);
return Ok(result);
}
統(tǒng)一異常處理
自定義異常數(shù)據(jù)結構
public class ApiException : Exception
{
public int code;
public string msg;
public ApiException(int code,string msg)
{
this.code = code;
this.msg = msg;
}
}
定義 異常篩選器 ExceptionFilterAttribute
public class ApiExceptionAttribute : ExceptionFilterAttribute
{
public override void OnException(HttpActionExecutedContext actionExecutedContext)
{
if(actionExecutedContext.Exception is ApiException)
{
var ex = (ApiException)actionExecutedContext.Exception;
var result = new Result(ex.code, ex.msg, null);
actionExecutedContext.ActionContext.Response = Utils.toJson(result);
}else
{
var ex = actionExecutedContext.Exception;
var result = new Result((int)Error.ReturnValue.內部錯誤, ex.Message, null);
actionExecutedContext.ActionContext.Response = Utils.toJson(result);
}
}
}
對應的 Controller或Action 添加對應的注解,或者全局配置
swagger
使用 Nuget 安裝 Swashbuckle 已經(jīng)自帶了UI
在 SwaggerConfig中配置對應的XML路徑
c.IncludeXmlComments(GetXmlCommentsPath());
...
protected static string GetXmlCommentsPath()
{
return System.String.Format(@"{0}\bin\對應的項目名稱.XML", System.AppDomain.CurrentDomain.BaseDirectory);
}
配置好之后，訪問 http://localhost:63380/swagger 就能看多對應的UI鹊碍，可以直接測試對應的接口
swagger 配置 Authorization
在 SwaggerConfig中配置
c.ApiKey("apiKey")
.Description("API Key Authentication")
.Name("Authorization")
.In("header");
c.EnableApiKeySupport("Authorization", "header");
image
