DotNet Web Api开发Restful Api相关-白红宇

DotNet Web Api开发Restful Api相关

开发环境

Visual Studio 2015

.Net Framework 4.5

Web Api

统一返回结果

Restful Api 的返回结果基本上使用的是 JSON 格式，在 .Net Web Api 中默认的是返回 XML 格式，需要修改一下返回的结果的格式

统一配置返回 JSON 格式

在 WebApiConfig中清除其他的格式，并添加 JSON 格式

config.Formatters.Clear();config.Formatters.Add(new JsonMediaTypeFormatter());复制代码

也可以去除 XML 格式

config.Formatters.Remove(config.Formatters.XmlFormatter);复制代码

还可以配置 JSON 数据的格式

缩进

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;}复制代码

统一的返回结果数据格式,对于 null添加注解 [JsonProperty(NullValueHandling = NullValueHandling.Ignore)] 数据可以选择忽略，不返回给客户端

public class Result{    ///     /// 错误信息    /// 
    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]    public string err;    ///     /// 具体的数据    /// 
    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]    public object data;    public Result(string err,object data)    {        this.err = err;        this.data = data;    }}复制代码

使用筛选器 ActionFilterAttribute 统一处理返回结果

public class ResultFilterAttribute : ActionFilterAttribute{    //在Action处理完相关的数据之后，会在经过这个方法处理    public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)    {        if (actionExecutedContext.ActionContext.Response != null)        {            var data = actionExecutedContext.ActionContext.Response.Content.ReadAsAsync

对应的 Controller或Action 添加对应的注解

[HttpGet][ResultFilter]public IHttpActionResult AllCategory(){    IEnumerable
    
      result  = _service.GetAllCategory();//具体的数据    return Ok(result);}复制代码

参数检查验证

在进行请求接口时，需要先对提交的数据参数做一些验证，验证数据的合法性，如果不合法就不再通过action，直接返回给客户端处理。

使用FluentValidation做参数验证

配置 FluentValidation

使用Nuget安装 FluentValidation.WebApi

需要验证的数据model

[Validator(typeof(UserReqValidator))]public class UserReq{    public string username;    public string password;}public class UserReqValidator : AbstractValidator
    
     {    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("参数非法", null);            actionContext.Response = Utils.toJson(System.Net.HttpStatusCode.BadRequest, result);        }    }}复制代码

对应的 Controller或Action 添加对应的注解,如果参数请求的参数非法，就会直接返回给客户端，就不会在经过对用的Action

[HttpPost][ParamsFilter][ResultFilter]public IHttpActionResult CategoryLevel([FromBody] UserReq req){    var ids = _service.GetQuestionIdsByLevel(req);    var result = _questionService.GetQuestionByIds(ids);    return Ok(result);}复制代码

统一异常处理

自定义异常数据结构

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 已经自带了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");复制代码