ASPNET WebApi项目框架搭建 （一）创建项目

发表于

（一）创建项目

一、新建webapi项目

1.打开VS2019，新建项目，选择ASP.NET Web 应用程序(.NET Framework)，框架选择.NET Framework4.5，如下图所示。

image.png

2.选择空项目，勾选Web API选项，去掉https支持，如下图所示

image.png

3.一般在前后端分离的项目中，后端返回的事json格式的数据，但是我们浏览器中显示的是xml格式的，这里需要修改“WebApiConfig”，添加以下代码，让它默认显示JSON的数据
1
2
3
4
5
6
7
8
9
c#复制代码var formatters = config.Formatters.Where(formatter =>
                  formatter.SupportedMediaTypes.Where(media =>
                  media.MediaType.ToString() == "application/xml" || media.MediaType.ToString() == "text/html").Count() > 0) //找到请求头信息中的介质类型
                  .ToList();

            foreach (var match in formatters)
            {
                config.Formatters.Remove(match);  //移除请求头信息中的XML格式
            }
4.Model文件夹下新建一个Person实体类
1
2
3
4
5
6
7
c#复制代码public class Person
    {
        public int Id { get; set; }
        public string Name { get; set; }
        public string Sex { get; set; }
        public int Age { get; set; }
    }
5.在我们的控制器里写一个Get请求方法，
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
c#复制代码 Person[] person = new Person[]
       {
            new Person { Id = 1, Name = "张三", Sex = "男", Age = 18 },
             new Person { Id = 1, Name = "李四", Sex = "女", Age = 18 },
              new Person { Id = 1, Name = "王二", Sex = "男", Age = 22 },
               new Person { Id = 1, Name = "麻子", Sex = "男", Age = 23 },

       };

        [HttpGet]
        public IHttpActionResult index()
        {
            return Ok(person);

        }

二.参数检查验证

1.Nuget安装FluentValidation.WebApi

image.png

2.修改Pserson类
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
c#复制代码[Validator(typeof(PersonValidator))]
    public class Person
    {
        public int Id { get; set; }
        public string Name { get; set; }
        public string Sex { get; set; }
        public int Age { get; set; }
    }

    public class PersonValidator : AbstractValidator<Person>
    {
        public PersonValidator()
        {
            RuleFor(m => m.Id).NotEmpty().NotNull().WithMessage("Id不能为空");
            RuleFor(m => m.Name).NotEmpty().NotNull().WithMessage("Name不能为空");
        }
    }
3.让 FluentValidation 生效，在 WebApiConfig中添加如下配置
1
2
3
4
5
6
7
8
c#复制代码public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        ...
        FluentValidationModelValidatorProvider.Configure(config);
    }
}

复制代码

4.新建Filter文件夹并添加ParamsFilterAttribute类
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
c#复制代码public class ParamsFilterAttribute : ActionFilterAttribute
    {
        public override void OnActionExecuting(HttpActionContext actionContext)
        {
             //如果参数非法
            if ( !actionContext.ModelState.IsValid)
            {
                actionContext.Response = actionContext.Request.CreateErrorResponse(HttpStatusCode.BadRequest, actionContext.ModelState);
                
            }
            //如果没有输入参数
            else if (actionContext.ActionArguments.Values.First() == null)
            {
                actionContext.Response = actionContext.Request.CreateErrorResponse(HttpStatusCode.BadRequest,"请输入参数!");
            }
        }
    }
5.控制器新建一个post请求
1
2
3
4
5
6
7
c#复制代码[HttpPost]
        [ParamsFilter]
        [Route("params")]
        public IHttpActionResult Params([FromBody] Person person)
        {
            return Json(person);
        }

postman模拟post请求，在body什么都不输入，提示请输入参数：

输入id，不输入name，提示name不能为空：

输入正确的参数,返回了数据：

本文转载自: 掘金

开发者博客 – 和开发相关的 这里全都有

0%