ASP.NET Core MVC 项目 WebApi

目录

一:WebApi

一:新建WebApi项目

二:WebApi项目案例

二:MinimalApi

一:新建MinimalApi项目

二:MinimalApi案例

三:MinimalApi分组封装

四:MinimalApi依赖注入

三:RestFull风格

四:通过路由特性访问

五:Swagger版本控制

一:新建Swagger版本控制类【ApiVersionInfo】

二:在控制器上使用版本控制

三:在Program.cs中配置Swagger

四:为Swagger设置文档注释


一:WebApi

一:新建WebApi项目

  1. 右键当前解决方案、添加、新建项目。
  2. 点击ASP.NET Core Web API下一步。
  3. 输入项目名称,后缀追加.WebApi。
  4. 勾选使用控制器(取消选中以使用最小Api)。
  5. 取消勾选不使用顶级语句。
  6. 点击创建。

二:WebApi项目案例

  1. 在当前项目的Controllers上右键添加控制器,点击MVC控制器-空,点击添加。
  2. 命名为HomeController.cs然后点击添加。

修改HomeController.cs文件

using Microsoft.AspNetCore.Mvc;

namespace Study_ASP.NET_Core_MVC.WebApi.Controllers
{
    [ApiController]
    [Route("[controller]")]
    public class HomeController : Controller
    {
        /// <summary>
        /// 初始化构造函数
        /// </summary>
        private readonly ILogger<HomeController> _logger;
        public HomeController(ILogger<HomeController> logger)
        {
            _logger = logger;
        }
        /// <summary>
        /// Get请求
        /// 获取数据
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        public object GetData()
        {
            return new
            {
                Id = 123,
                Name = "VinCente"
            };
        }
        /// <summary>
        /// Post请求
        /// 新增数据
        /// </summary>
        /// <returns></returns>
        [HttpPost]
        public object PostData()
        {
            return new
            {
                Success = true,
                Message = "新增操作成功"
            };
        }
        /// <summary>
        /// Put请求
        /// 修改数据
        /// </summary>
        /// <returns></returns>
        [HttpPut]
        public object PutDate()
        {
            return new
            {
                Success = true,
                Message = "修改操作成功"
            };
        }
        /// <summary>
        /// Delete请求
        /// 删除数据
        /// </summary>
        /// <returns></returns>
        [HttpDelete]
        public object DeleteDate()
        {
            return new
            {
                Success = true,
                Message = "删除操作成功"
            };
        }
    }
}

结果截图:

二:MinimalApi

一:新建MinimalApi项目

  1. 右键当前解决方案、添加、新建项目。
  2. 点击ASP.NET Core Web API下一步。
  3. 输入项目名称,后缀追加.MinimalApi。
  4. 取消勾选使用控制器(取消选中以使用最小Api)。
  5. 取消勾选不使用顶级语句。
  6. 点击创建。

二:MinimalApi案例

//表示整个应用程序,调用CreateBuilder方法创建一个WebApplicationBuilder对象
var builder = WebApplication.CreateBuilder(args);

//向管道容器添加注册中间件
//添加注册Swagger中间件
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

//配置管道容器中间件,构造WebApplication实例
var app = builder.Build();

//配置HTTP请求管道判断开发者模式
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}
//向管道添加用于将HTTP请求重定向到HTTPS的中间件
app.UseHttpsRedirection();
//向管道添加MapGet请求数据中间件返回新数据
app.MapGet("/Create", () =>
{
    return new
    {
        Id = 123,
        Name = "VinCente",
        Age = 28
    };
}).WithName("Query");
//向管道添加MapPost请求数据中间件返回新增操作成功
app.MapPost("/Add", () =>
{
    return new
    {
        Success=true,
        Message="新增操作成功"
    };
}).WithName("Add");
//向管道添加MapPut请求数据中间件返回修改操作成功
app.MapPut("/Update", () =>
{
    return new
    {
        Success = true,
        Message = "修改操作成功"
    };
}).WithName("Update");
//向管道添加MapDelete请求数据中间件返回删除操作成功
app.MapDelete("/Delete", () =>
{
    return new
    {
        Success = true,
        Message = "删除操作成功"
    };
}).WithName("Delete");


//向管道添加启动应用程序中间件
app.Run();

结果截图:

三:MinimalApi分组封装

当前MinimalApi项目右键添加类,命名为OrderMinimalApi,点击添加。

修改当前OrderMinimalApi分组封装类。

namespace Study_ASP.NET_Core_MVC.MinimalApi
{
    public static class OrderMinimalApi
    {
        public static void OrderMinimalApiExtension(this WebApplication app)
        {
            //向管道添加MapGet请求数据中间件返回新数据
            app.MapGet("/CreateOrder", () =>
            {
                return new
                {
                    Id = 123,
                    Name = "VinCente",
                    Age = 28
                };
            }).WithTags("Order");
            //向管道添加MapPost请求数据中间件返回新增操作成功
            app.MapPost("/AddOrder", () =>
            {
                return new
                {
                    Success = true,
                    Message = "新增操作成功"
                };
            }).WithTags("Order");
            //向管道添加MapPut请求数据中间件返回修改操作成功
            app.MapPut("/UpdateOrder", () =>
            {
                return new
                {
                    Success = true,
                    Message = "修改操作成功"
                };
            }).WithTags("Order");
            //向管道添加MapDelete请求数据中间件返回删除操作成功
            app.MapDelete("/DeleteOrder", () =>
            {
                return new
                {
                    Success = true,
                    Message = "删除操作成功"
                };
            }).WithTags("Order");
        }
    }
}

当前MinimalApi项目右键添加类,命名为ProductMinimalApi,点击添加。

修改当前ProductMinimalApi分组封装类。

namespace Study_ASP.NET_Core_MVC.MinimalApi
{
    public static class ProductMinimalApi
    {
        public static void ProductMinimalApiExtension(this WebApplication app)
        {
            //向管道添加MapGet请求数据中间件返回新数据
            app.MapGet("/CreateProduct", () =>
            {
                return new
                {
                    Id = 123,
                    Name = "VinCente",
                    Age = 28
                };
            }).WithTags("Product");
            //向管道添加MapPost请求数据中间件返回新增操作成功
            app.MapPost("/AddProduct", () =>
            {
                return new
                {
                    Success = true,
                    Message = "新增操作成功"
                };
            }).WithTags("Product");
            //向管道添加MapPut请求数据中间件返回修改操作成功
            app.MapPut("/UpdateProduct", () =>
            {
                return new
                {
                    Success = true,
                    Message = "修改操作成功"
                };
            }).WithTags("Product");
            //向管道添加MapDelete请求数据中间件返回删除操作成功
            app.MapDelete("/DeleteProduct", () =>
            {
                return new
                {
                    Success = true,
                    Message = "删除操作成功"
                };
            }).WithTags("Product");
        }
    }
}

修改当前项目下的Program.cs文件添加注册

using Study_ASP.NET_Core_MVC.MinimalApi;
//表示整个应用程序,调用CreateBuilder方法创建一个WebApplicationBuilder对象
var builder = WebApplication.CreateBuilder(args);

//向管道容器添加注册中间件
//添加注册Swagger中间件
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

//配置管道容器中间件,构造WebApplication实例
var app = builder.Build();

//配置HTTP请求管道判断开发者模式
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}
//向管道添加用于将HTTP请求重定向到HTTPS的中间件
app.UseHttpsRedirection();

//注册OrderMinimalApi中间件
app.OrderMinimalApiExtension();
//注册ProductMinimalApi中间件
app.ProductMinimalApiExtension();

//向管道添加启动应用程序中间件
app.Run();

结果截图:

四:MinimalApi依赖注入

在当前MinimalApi项目下的依赖项右键添加项目引用,选择.Interfaces项目、选择.Service项目确定引用。

修改OrderMinimalApi注入参数服务

using Study_ASP.NET_Core_MVC.Interfaces;

namespace Study_ASP.NET_Core_MVC.MinimalApi
{
    public static class OrderMinimalApi
    {
        public static void OrderMinimalApiExtension(this WebApplication app)
        {
            //向管道添加MapGet请求数据中间件返回新数据
            //上下文注入、参数注入、Service服务注入
            app.MapGet("/CreateOrder", (HttpContext context, int Id, IPhone iPhone) =>
            {
                //获取上下文
                var QueryText = context.Request.Query;
                //获取参数
                var OrderId = Id;
                //获取Service服务
                var iPhone1 = iPhone;
                //返回数据
                return new
                {
                    Id = 123,
                    Name = "VinCente",
                    Age = 28
                };
            }).WithTags("Order");
            //向管道添加MapPost请求数据中间件返回新增操作成功
            app.MapPost("/AddOrder", () =>
            {
                return new
                {
                    Success = true,
                    Message = "新增操作成功"
                };
            }).WithTags("Order");
            //向管道添加MapPut请求数据中间件返回修改操作成功
            app.MapPut("/UpdateOrder", () =>
            {
                return new
                {
                    Success = true,
                    Message = "修改操作成功"
                };
            }).WithTags("Order");
            //向管道添加MapDelete请求数据中间件返回删除操作成功
            app.MapDelete("/DeleteOrder", () =>
            {
                return new
                {
                    Success = true,
                    Message = "删除操作成功"
                };
            }).WithTags("Order");
        }
    }
}

修改Program.cs文件注入Interfaces服务

using Study_ASP.Net_Core_MVC.Services;
using Study_ASP.NET_Core_MVC.Interfaces;
using Study_ASP.NET_Core_MVC.MinimalApi;
//表示整个应用程序,调用CreateBuilder方法创建一个WebApplicationBuilder对象
var builder = WebApplication.CreateBuilder(args);

//向管道容器添加注册中间件
//添加注册Swagger中间件
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();


//注册Interfaces服务中间件
builder.Services.AddTransient<IPhone, ApplePhone>();


//配置管道容器中间件,构造WebApplication实例
var app = builder.Build();

//配置HTTP请求管道判断开发者模式
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}
//向管道添加用于将HTTP请求重定向到HTTPS的中间件
app.UseHttpsRedirection();

//注册OrderMinimalApi中间件
app.OrderMinimalApiExtension();
//注册ProductMinimalApi中间件
app.ProductMinimalApiExtension();

//向管道添加启动应用程序中间件
app.Run();

三:RestFull风格

把服务器上的服务资源化,统一Url地址,通过请求进入增删改查等功能。

四:通过路由特性访问

  1. 通过在方法名称上添加路由特性[Route("DeleteData")]访问。
  2. 通过在控制器名称上添加路由特性[Route("[controller]/[action]")]访问。
using Microsoft.AspNetCore.Mvc;

namespace Study_ASP.NET_Core_MVC.WebApi.Controllers
{
    [ApiController]
    [Route("[controller]/[action]")]
    public class HomeController : Controller
    {
        /// <summary>
        /// 初始化构造函数
        /// </summary>
        private readonly ILogger<HomeController> _logger;
        public HomeController(ILogger<HomeController> logger)
        {
            _logger = logger;
        }
        /// <summary>
        /// Get请求
        /// 获取数据
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        public object GetData()
        {
            return new
            {
                Id = 123,
                Name = "VinCente"
            };
        }
        /// <summary>
        /// Post请求
        /// 新增数据
        /// </summary>
        /// <returns></returns>
        [HttpPost]
        public object PostData()
        {
            return new
            {
                Success = true,
                Message = "新增操作成功"
            };
        }
        /// <summary>
        /// Put请求
        /// 修改数据
        /// 通过路由特性访问
        /// </summary>
        /// <returns></returns>
        [HttpPut]
        [Route("PutDate")]
        public object PutDate()
        {
            return new
            {
                Success = true,
                Message = "修改操作成功"
            };
        }
        /// <summary>
        /// Delete请求
        /// 删除数据
        /// 通过路由特性访问
        /// </summary>
        /// <returns></returns>
        [HttpDelete]
        [Route("DeleteDate")]
        public object DeleteDate()
        {
            return new
            {
                Success = true,
                Message = "删除操作成功"
            };
        }
    }
}

结果截图:

五:Swagger版本控制

一:新建Swagger版本控制类【ApiVersionInfo】

namespace Study_ASP.NET_Core_MVC.WebApi
{
    public static class ApiVersionInfo
    {
        public static string V1;
        public static string V2;
        public static string V3;
        public static string V4;
        public static string V5;
    }
}

二:在控制器上使用版本控制

using Microsoft.AspNetCore.Mvc;

namespace Study_ASP.NET_Core_MVC.WebApi.Controllers
{
    /// <summary>
    /// 在控制器上应用特性
    /// Api特性
    /// 路由特性
    /// Swagger版本控制
    /// </summary>
    [ApiController]
    [Route("[controller]")]
    [ApiExplorerSettings(GroupName =nameof(ApiVersionInfo.V1))]
    public class HomeController : Controller
    {
        /// <summary>
        /// 初始化构造函数
        /// </summary>
        private readonly ILogger<HomeController> _logger;
        public HomeController(ILogger<HomeController> logger)
        {
            _logger = logger;
        }
        /// <summary>
        /// Get请求
        /// 获取数据
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        public object GetData()
        {
            return new
            {
                Id = 123,
                Name = "VinCente"
            };
        }
        /// <summary>
        /// Post请求
        /// 新增数据
        /// </summary>
        /// <returns></returns>
        [HttpPost]
        public object PostData()
        {
            return new
            {
                Success = true,
                Message = "新增操作成功"
            };
        }
        /// <summary>
        /// Put请求
        /// 修改数据
        /// 通过路由特性访问
        /// </summary>
        /// <returns></returns>
        [HttpPut]
        [Route("PutDate")]
        public object PutDate()
        {
            return new
            {
                Success = true,
                Message = "修改操作成功"
            };
        }
        /// <summary>
        /// Delete请求
        /// 删除数据
        /// 通过路由特性访问
        /// </summary>
        /// <returns></returns>
        [HttpDelete]
        [Route("DeleteDate")]
        public object DeleteDate()
        {
            return new
            {
                Success = true,
                Message = "删除操作成功"
            };
        }
    }
}

三:在Program.cs中配置Swagger

using Microsoft.OpenApi.Models;
using Study_ASP.NET_Core_MVC.WebApi;
using System.Reflection;
//表示整个应用程序,调用CreateBuilder方法创建一个WebApplicationBuilder对象
var builder = WebApplication.CreateBuilder(args);

//向管道容器添加注册中间件
//添加注册Controller中间件
//添加注册Swagger中间件
builder.Services.AddControllers();
builder.Services.AddEndpointsApiExplorer();
//配置Swagger
builder.Services.AddSwaggerGen(c =>
{
    //版本控制
    foreach(FieldInfo field in typeof(ApiVersionInfo).GetFields())
    {
        c.SwaggerDoc(field.Name, new OpenApiInfo()
        {
            Title = $"当前Swagger版本为:{field.Name}",
            Version = field.Name,
            Description = $"当前Swagger版本为:{field.Name}"
        });
    }
});

//配置管道容器中间件,构造WebApplication实例
var app = builder.Build();

//配置HTTP请求管道判断开发者模式
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI(c =>
    {
        foreach(FieldInfo field in typeof(ApiVersionInfo).GetFields())
        {
            c.SwaggerEndpoint($"/Swagger/{field.Name}/Swagger.json", $"{field.Name}");
        }
    });
}

//向管道添加用于将HTTP请求重定向到HTTPS的中间件
app.UseHttpsRedirection();
//向管道添加用于身份鉴权授权中间件
app.UseAuthorization();
//向管道添加用于Controller中间件
app.MapControllers();


//向管道添加启动应用程序中间件
app.Run();

四:为Swagger设置文档注释

  1. 在当前WebApi项目右键属性,依次点击生成、输出、勾选文档文件生成包含API文档的文件。
  2. 在Program.cs文件中配置文档注释路径。
using Microsoft.OpenApi.Models;
using Study_ASP.NET_Core_MVC.WebApi;
using System.Reflection;
//表示整个应用程序,调用CreateBuilder方法创建一个WebApplicationBuilder对象
var builder = WebApplication.CreateBuilder(args);

//向管道容器添加注册中间件
//添加注册Controller中间件
//添加注册Swagger中间件
builder.Services.AddControllers();
builder.Services.AddEndpointsApiExplorer();
//配置Swagger
builder.Services.AddSwaggerGen(c =>
{
    //版本控制
    foreach(FieldInfo field in typeof(ApiVersionInfo).GetFields())
    {
        c.SwaggerDoc(field.Name, new OpenApiInfo()
        {
            Title = $"当前Swagger版本为:{field.Name}",
            Version = field.Name,
            Description = $"当前Swagger版本为:{field.Name}"
        });
    }
    //设置文档注释
    //获取当前项目绝对路径
    string basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);
    //生成Xml文件
    string xmlPath = Path.Combine(basePath, "Study ASP.NET Core MVC.WebApi.xml");
    //加载Xml文件
    c.IncludeXmlComments(xmlPath);
});

//配置管道容器中间件,构造WebApplication实例
var app = builder.Build();

//配置HTTP请求管道判断开发者模式
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI(c =>
    {
        foreach(FieldInfo field in typeof(ApiVersionInfo).GetFields())
        {
            c.SwaggerEndpoint($"/Swagger/{field.Name}/Swagger.json", $"{field.Name}");
        }
    });
}

//向管道添加用于将HTTP请求重定向到HTTPS的中间件
app.UseHttpsRedirection();
//向管道添加用于身份鉴权授权中间件
app.UseAuthorization();
//向管道添加用于Controller中间件
app.MapControllers();


//向管道添加启动应用程序中间件
app.Run();

效果截图:

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Vin Cente

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值