07 使用 ASP.NET Core 创建 Web API之待办事项Api实现

已于 2023-11-18 00:02:48 修改
阅读量119 收藏
点赞数
分类专栏： Net6-WebApi 文章标签： asp.net 前端 后端
于 2023-11-18 00:01:29 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_42574478/article/details/134472816
版权

1 api功能一览表

2个查询+增删改

API描述请求正文响应正文
GET /api/todoitems获取所有待办事项None待办事项的数组
GET /api/todoitems/{id}按 ID 获取项None待办事项
POST /api/todoitems添加新项待办事项待办事项
PUT /api/todoitems/{id}更新现有项待办事项None
DELETE /api/todoitems/{id}删除项NoneNone

2 创建ASP.NET Core Web API”模板项目

选择ASP.NET Core Web API”模板

项目命名为“TodoApi”

取消https

“框架”为“.NET 6.0 (长期支持)”

选中“使用控制器(取消选中以使用最小 API)”

2.1 更新 launchUrl

Properties\launchSettings.json

"launchUrl": "api/todoitems",

2.2 添加模型类

namespace TodoApi.Models
{
    public class TodoItem
    {
        public long Id { get; set; }
        public string? Name { get; set; }
        public bool IsComplete { get; set; }
    }
}

2.3 添加数据库上下文

TodoDbContext.cs

添加nuget包：Microsoft.EntityFrameworkCore

using Microsoft.EntityFrameworkCore;
using System.Diagnostics.CodeAnalysis;

namespace TodoApi.Models
{
    public class TodoDbContext : DbContext
    {
        public TodoContext(DbContextOptions<TodoContext> options)
            : base(options)
        {
        }

        public DbSet<TodoItem> TodoItems { get; set; } = null!;
    }
}

2.3 注册数据库上下文（InMemory）

内存数据库

添加nuget包：Microsoft.EntityFrameworkCore.InMemory

public static void Main(string[] args)
{
    var builder=  WebApplication.CreateBuilder(args);

    builder.Services.AddControllers();

    builder.Services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new() { Title = "TodoApi", Version = "v1" });
    });

    builder.Services.AddDbContext<TodoDbContext>(opt =>
        opt.UseInMemoryDatabase("TodoList"));
    var app = builder.Build();
    if (builder.Environment.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
        app.UseSwagger();
        app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "TodoApi v1"));
    }
    app.MapControllers();
    app.Run();
}

2.4 创建api控制器

基于Entityframeworkcore实体的api控制器需要依赖包

添加其操作使用实体框架的 API 控制器

“模型类”中选择“TodoItem (TodoApi.Models)”

在“数据上下文类”中选择“TodoDbContext (TodoAPI.Models)”

<ItemGroup>

  <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="6.0.23" />
  <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="6.0.23" />
  <PackageReference Include="Microsoft.EntityFrameworkCore.Tools" Version="6.0.23">
    <PrivateAssets>all</PrivateAssets>
    <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
  </PackageReference>
  <PackageReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Design" Version="6.0.16" />

</ItemGroup>

TodoItemsController.cs生成如下

using Microsoft.AspNetCore.Mvc;
using Microsoft.EntityFrameworkCore;
using WebApiTest1.Models.Entities.TodoSystem;

namespace WebApiTest1.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class TodoItemsController : ControllerBase
    {
        private readonly TodoDbContext _context;

        public TodoItemsController(TodoDbContext context)
        {
            _context = context;
        }

        // GET: api/TodoItems
        [HttpGet]
        public async Task<ActionResult<IEnumerable<TodoItem>>> GetTodoItems()
        {
          if (_context.TodoItems == null)
          {
              return NotFound();
          }
            return await _context.TodoItems.ToListAsync();
        }

        // GET: api/TodoItems/5
        [HttpGet("{id}")]
        public async Task<ActionResult<TodoItem>> GetTodoItem(long id)
        {
          if (_context.TodoItems == null)
          {
              return NotFound();
          }
            var todoItem = await _context.TodoItems.FindAsync(id);

            if (todoItem == null)
            {
                return NotFound();
            }

            return todoItem;
        }

        // PUT: api/TodoItems/5
        // To protect from overposting attacks, see https://go.microsoft.com/fwlink/?linkid=2123754
        [HttpPut("{id}")]
        public async Task<IActionResult> PutTodoItem(long id, TodoItem todoItem)
        {
            if (id != todoItem.Id)
            {
                return BadRequest();
            }

            _context.Entry(todoItem).State = EntityState.Modified;

            try
            {
                await _context.SaveChangesAsync();
            }
            catch (DbUpdateConcurrencyException)
            {
                if (!TodoItemExists(id))
                {
                    return NotFound();
                }
                else
                {
                    throw;
                }
            }

            return NoContent();
        }

        // POST: api/TodoItems
        // To protect from overposting attacks, see https://go.microsoft.com/fwlink/?linkid=2123754
        [HttpPost]
        public async Task<ActionResult<TodoItem>> PostTodoItem(TodoItem todoItem)
        {
          if (_context.TodoItems == null)
          {
              return Problem("Entity set 'TodoDbContext.TodoItems'  is null.");
          }
            _context.TodoItems.Add(todoItem);
            await _context.SaveChangesAsync();

            return CreatedAtAction("GetTodoItem", new { id = todoItem.Id }, todoItem);
        }

        // DELETE: api/TodoItems/5
        [HttpDelete("{id}")]
        public async Task<IActionResult> DeleteTodoItem(long id)
        {
            if (_context.TodoItems == null)
            {
                return NotFound();
            }
            var todoItem = await _context.TodoItems.FindAsync(id);
            if (todoItem == null)
            {
                return NotFound();
            }

            _context.TodoItems.Remove(todoItem);
            await _context.SaveChangesAsync();

            return NoContent();
        }

        private bool TodoItemExists(long id)
        {
            return (_context.TodoItems?.Any(e => e.Id == id)).GetValueOrDefault();
        }
    }
}

2.5 更新 PostTodoItem create 方法

使用 nameof 运算符使用nameof(GetTodoItem)

[HttpPost]
public async Task<ActionResult<TodoItem>> PostTodoItem(TodoItem todoItem)
{
  if (_context.TodoItems == null)
  {
      return Problem("Entity set 'TodoDbContext.TodoItems'  is null.");
  }
    _context.TodoItems.Add(todoItem);
    await _context.SaveChangesAsync();

    return CreatedAtAction(nameof(GetTodoItem), new { id = todoItem.Id }, todoItem);
}

2.6 防止过度发布

生产应用通常使用模型的子集来限制输入和返回的数据。

模型的子集通常称为数据传输对象 (DTO)、输入模型或视图模型。

DTO 可用于：

  • 防止过度发布。
  • 隐藏客户端不应查看的属性。
  • 省略一些属性以缩减有效负载大小。
  • 平展包含嵌套对象的对象图。 对客户端而言，平展的对象图可能更方便。
如实体模型中含有Secret字段
namespace TodoApi.Models
{
    public class TodoItem
    {
        public long Id { get; set; }
        public string? Name { get; set; }
        public bool IsComplete { get; set; }
        public string? Secret { get; set; }
    }
}
在DTO中不包含Secret字段
namespace TodoApi.Models
{
    public class TodoItemDTO
    {
        public long Id { get; set; }
        public string? Name { get; set; }
        public bool IsComplete { get; set; }
    }
}

添加转换方法ItemToDTO
private static TodoItemDTO ItemToDTO(TodoItem todoItem) =>
            new TodoItemDTO
            {
                Id = todoItem.Id,
                Name = todoItem.Name,
                IsComplete = todoItem.IsComplete
            };

修改后

using Microsoft.AspNetCore.Mvc;
using Microsoft.EntityFrameworkCore;
using TodoApi.Models;

namespace TodoApi.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class TodoItemsController : ControllerBase
    {
        private readonly TodoContext _context;

        public TodoItemsController(TodoContext context)
        {
            _context = context;
        }

        // GET: api/TodoItems
        [HttpGet]
        public async Task<ActionResult<IEnumerable<TodoItemDTO>>> GetTodoItems()
        {
            return await _context.TodoItems
                .Select(x => ItemToDTO(x))
                .ToListAsync();
        }

        // GET: api/TodoItems/5
        [HttpGet("{id}")]
        public async Task<ActionResult<TodoItemDTO>> GetTodoItem(long id)
        {
            var todoItem = await _context.TodoItems.FindAsync(id);

            if (todoItem == null)
            {
                return NotFound();
            }

            return ItemToDTO(todoItem);
        }
        // PUT: api/TodoItems/5
        // To protect from overposting attacks, see https://go.microsoft.com/fwlink/?linkid=2123754
        [HttpPut("{id}")]
        public async Task<IActionResult> UpdateTodoItem(long id, TodoItemDTO todoItemDTO)
        {
            if (id != todoItemDTO.Id)
            {
                return BadRequest();
            }

            var todoItem = await _context.TodoItems.FindAsync(id);
            if (todoItem == null)
            {
                return NotFound();
            }

            todoItem.Name = todoItemDTO.Name;
            todoItem.IsComplete = todoItemDTO.IsComplete;

            try
            {
                await _context.SaveChangesAsync();
            }
            catch (DbUpdateConcurrencyException) when (!TodoItemExists(id))
            {
                return NotFound();
            }

            return NoContent();
        }
        // POST: api/TodoItems
        // To protect from overposting attacks, see https://go.microsoft.com/fwlink/?linkid=2123754
        [HttpPost]
        public async Task<ActionResult<TodoItemDTO>> CreateTodoItem(TodoItemDTO todoItemDTO)
        {
            var todoItem = new TodoItem
            {
                IsComplete = todoItemDTO.IsComplete,
                Name = todoItemDTO.Name
            };

            _context.TodoItems.Add(todoItem);
            await _context.SaveChangesAsync();

            return CreatedAtAction(
                nameof(GetTodoItem),
                new { id = todoItem.Id },
                ItemToDTO(todoItem));
        }

        // DELETE: api/TodoItems/5
        [HttpDelete("{id}")]
        public async Task<IActionResult> DeleteTodoItem(long id)
        {
            var todoItem = await _context.TodoItems.FindAsync(id);

            if (todoItem == null)
            {
                return NotFound();
            }

            _context.TodoItems.Remove(todoItem);
            await _context.SaveChangesAsync();

            return NoContent();
        }

        private bool TodoItemExists(long id)
        {
            return _context.TodoItems.Any(e => e.Id == id);
        }

        private static TodoItemDTO ItemToDTO(TodoItem todoItem) =>
            new TodoItemDTO
            {
                Id = todoItem.Id,
                Name = todoItem.Name,
                IsComplete = todoItem.IsComplete
            };
    }
}

2.7 使用Mssqlserver数据库

2.7.1 安装nuget包

<PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="6.0.23" />
<PackageReference Include="Microsoft.EntityFrameworkCore.Tools" Version="6.0.23">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Design" Version="6.0.16" />

2.7.2 数据库连接字符串配置

"ConnectionStrings": {
  "Default": "Data Source=.;Initial Catalog=WebApiTest1Db;User ID=sa;Password=123456"
}

2.7.3 注册TodoDbContext

var connString = builder.Configuration.GetConnectionString("Default");          
builder.Services.AddDbContext<TodoDbContext>(opt =>
{
    opt.UseSqlServer(connString);
});

2.7.4 数据迁移

nuget包管理器控制台输入：

启动项目选中好，默认项目选中好

# 初始化迁移文件
add-migration init 
# 第一次迁移到数据库,会创建数据库
update-database

2.7.5 添加或修改字段

修改TodoItem的Title字段

public string? Title { get; set; }
改为
public string Title { get; set; } 或者
public string Title { get; set; }=null!;

生成新的迁移文件
add-migration TodoItem_Title_require 
# 再次迁移到数据库,会在迁移表添加一条记录
update-database

使用dto时要注意：

public string Title { get; set; } 或者
public string Title { get; set; }=null!;
在有[ApiController]的情况下能验证是否为必填参数

`

海纳百川程序员
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
ASP.NET Core Web API
djwuhjwiwhe的博客
01-10 742
WebApi是什么？第一个Asp.NetCoreWebApi程序
.net core请求外部api接口
热门推荐
你要明白，任何问题都不是孤立存在的，一定有人曾经遇到过，并且已经有更好的解决办法了，只是我还不知道。我不应该在黑暗中独自前行，去重新发明轮子，也许我的顿悟，只是别人的基本功！我应该要站在巨人的肩膀上，学习更成熟的经验和方法，然后再来解决这个问题
01-14 1万+
1、打开net core项目中的Startup.cs文件，找到ConfigureServices方法，添加HttpClient services.AddHttpClient();//注入httpclient 用于调用外部api 2.控制器中注入IHttpClientFactory using System.Net.Http; private IHttpClientFactory _httpClient; public WeChatController( IHttp
​​​​​​​​​​​​​​.NET Core Web API架构+应用场景+实例
最新发布
赵玉的专栏
02-26 3547
.NET Core Web API 非常适合设计 RESTful 风格的 API，这些 API 遵循 HTTP 协议，使用 URI 来标识资源，并通过不同的 HTTP 方法（GET、POST、PUT、DELETE 等）来操作资源。：.NET Core Web API 提供了强大的验证和授权机制，以确保 API 请求的数据有效性和安全性。：对于需要暴露数据给多个客户端（如 Web、移动、桌面应用等）的应用程序，.NET Core Web API 可以作为数据的统一入口，提供数据访问和操作的功能。
C# 搭建一个简单的WebApi项目23.10.10
zgscwxd的博客
10-10 2044
C# 搭建一个简单的WebApi项目
.netCore WebAPI入门到实战(一)
Renner
05-19 7904
前言 本次开发环境为vs2022 + sql2019，该篇文章旨在记录学习.netCore过程中踩到的一些坑，项目会基于.netCore WebAPI一步一步实现数据库的增删查改操作，并记录服务器部署过程中踩到的一些坑，如最常见的跨域问题和不同网络下访问的问题； 一、WebAPI实现 1、新建项目，选择ASP.NET Core Web API,点击下一步 2、框架选择.NET6.0(一定要用这个版本，网上有很多教程都是基于3.0或5.0的教程，如果选错了，后面配置的复杂度会比较高，建议...
Asp.Net Core WebAPI使用Swagger时API隐藏和分组详解
10-17
主要给大家介绍了关于Asp.Net Core WebAPI使用Swagger时API隐藏和分组的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用Asp.Net Core具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
ASP.NET Core奇淫技巧之动态WebApi的实现
10-14
主要介绍了ASP.NET Core奇淫技巧之动态WebApi的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
ASP.NET Core 2.0 WebApi全局配置及日志实例
10-18
下面小编就为大家分享一篇ASP.NET Core 2.0 WebApi全局配置及日志实例，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
ASP.NET Core Web API之Token验证
06-26
ASP.NET Core Web API采用Token进行身份验证。 主要技术：ASP.NET Core Web API , JWT , Json web token 包括获取Token，Token验证，生成Token等内容 具体可参考个人文章【ASP.NET Core Web API之Token验证】
ASP.NET Core WebApi中使用FluentValidation验证数据模型的方法
01-20
如果我们使用FluentValidation构建ASP.NET Core Web API，输入验证的任务将比以前容易的多。 FluentValidation是一个非常流行的构建强类型验证规则的.NET库。 配置项目 第一步：下载FluentValidation 我们可以使用...
DotNETCore_API
01-27
微软进入开源时代，跨平台，这个API是官网下载的，大家可以参考。
ASP.NETCore-API
02-21
ASP.NETCore-API
asp.net core框架搭建1-搭建webapi，对数据增删改查接口模板(附源码)
xcLeigh
07-11 4547
asp.net core框架搭建1-搭建webapi，通过ado操作数据库，对数据进行增删改查，分页等操作，接口都已实现，配置号数据库连接串后，可以直接运行查看效果。 本文章介绍asp.net core webapi框架搭建，然后开发增删改查和工具接口，将一步步带着大家，实现目标。所有操作过程将展现在本篇文章，下面咋们一起来实现它吧。
.NetCore——API设置统一路由
qiaofan_乔凡的博客
05-01 2138
NetCore3.1——API设置统一路由 一、前言 今天说一下在.netcore3.1的版本下设置统一的API路由。 二、实现 添加MvcOptionsExtensions扩展类 如下 public static class MvcOptionsExtensions { /// <summary> /// 扩展方法 /// ...
C# ASP.NET Web Core API (.NET 6.0)
熊思雨的博客
09-24 6381
ASP.NET Core Web API 是 ASP.NET Core MVC 的一个功能。ASP.NET Core MVC 包含了对 Web API 的支持。可以构建多种客户端的 HTTP 服务。ASP.NET Core Web API可用于在 .NET Core 上构建 RESTful 应用程序。框架包含对 HTTP 内容协商的支持，内置支持以 JSON 或 XML 格式化的数据。编写自定义格式化程序已添加对自有格式的支持。使用链接生成对超媒体的支持。
创建WebApi
ailaiai1305的博客
06-20 187
一.创建 Web 项目 使用vs创建项目，选择“ASP.NET Core Web 应用程序”模板，将项目命名为 TodoApi，然后单击“确定”。 在“新建 ASP.NET Core Web 应用程序 - TodoApi”对话框中，选择 ASP.NET Core 版本。选择“API”模板，然后单击“确定”。请不要选择“启用 Docker 支持”。 添加模型类 新建文...
api接口参数加密_.NetCore对接各大财务软件凭证API——用友系列（1）
weixin_42366533的博客
12-13 1347
.NetCore对接各大财务软件凭证API——用友系列（1） 一.前言今天，我们转战用友系列的第一个产品---T+/Tplus。前两篇文章讲解分享的都是金蝶的产品，因为本身公司牵涉的业务有限，后续有金蝶其他产品的API对接业务时，会继续来分享经验。T+的API接口，哎，想起来都是心酸泪。关于该接口的对接开发经验，我之前也简单记录了一些，传送门记录用友T+接口对接的心酸历程 今天我们就来详细解析下这...
.net core webapi （1） 搭建
lxysoid的博客
03-15 5978
以.NET Core为框架，搭建出一个功能完善的WebApi框架。实现后台管理系统、前台系统和App系统的统一管理。 该框架欲集成Swagger作为接口显示文档，集成SqlSugar作为数据库操作ORM，集成LayUI作为后台管理系统前端框架，集成支付宝和微信的SDK实现支付功能； 实现接口权限验证功能，实现从后台管理系统无代码化的自动生成实体类、自动生成基础的增删改查接口、自动生成基础版的后台管...
netCore2.0 Api 跨域(Cors)
越一步之距
01-30 9122
1、在使用netCore2.0 使用WebApi的过程中涉及到了跨域处理。 在Microsoft.AspNetCore.All包中包含跨域Cors的处理，不必单独添加。  2、打开Startup.cs文件，在ConfigureServices 中配置跨域 3、在Configure中使用或者是在Controller中配置，这两种方法都可以。 在Configur
asp.net.core 创建webapi
01-10
以下是使用 ASP.NET Core 创建 Web API 的步骤： 1. 安装 ASP.NET Core：首先，你需要在你的计算机上安装 ASP.NET Core。你可以从官方网站（https://dotnet.microsoft.com/download）下载和安装 .NET Core SDK，它...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值