.Net WebAPI(一)


文章目录

  • 项目地址
  • 一、WebAPI基础
    • 1. 项目初始化
      • 1.1 创建简单的API
        • 1.1.1 get请求
        • 1.1.2 post请求
        • 1.1.3 put请求
        • 1.1.4 Delete请求
      • 1.2 webapi的流程
    • 2.Controllers
      • 2.1 创建一个shirts的Controller
    • 3. Routing
      • 3.1 使用和创建MapControllers
      • 3.2 使用Routing的模板语言
    • 4. Mould Binding
      • 4.1 指定数据的来源
        • 4.1.1 给Request请求添加
          • 1. FromRoute
          • 2. FromQuery
          • 3. FromHeader
        • 4.1.2 给Post请求添加
          • 1. FromBody
          • 2. FromForm
    • 5. Mould Validation
      • 5.1 添加Model Validation
      • 5.2 添加自定义的Validation
    • 6. WebApi Return Types
      • 6.1 直接返回对象
      • 6.2 返回多类型
    • 7. Action filter
      • 7.1 创建filter


项目地址

  • 教程作者:
  • 教程地址:
  • 代码仓库地址:
  • 所用到的框架和插件:
webapi

一、WebAPI基础

1. 项目初始化

  1. 创建一个一个项目文件夹,并且在控制台输入
dotnew webapi -n Restaurants.API --noopenapi -controllers
  1. 但是此时的项目是没有sln文件的,创建sln文件,但是这时候打开vs显示的是空项目
dotnet new sln
  1. 将项目添加到vs里
 dotnet sln add ./Restaurants.API

1.1 创建简单的API

  • 在program.cs里使用routing中间件配置路由
1.1.1 get请求
  • 获取所有的shirts
app.MapGet("/shirts", () =>
{return "Reading all the shirts";
});
  • 根据ID获取一个
//2.get shirt by id 
app.MapGet("/shirts/{id}", (int id) =>
{return $"Reading shirt with ID: {id}";
});
1.1.2 post请求
app.MapPost("/shirts", () =>
{return "Creating a new shirt.";
});
1.1.3 put请求

更新

app.MapPut("/shirts/{id}", (int id) =>
{return $"Updating shirt with ID: {id}";
});
1.1.4 Delete请求

删除

app.MapDelete("/shirts/{id}", (int id) =>
{return $"Deleting shirt with ID: {id}";
});

1.2 webapi的流程

在这里插入图片描述

2.Controllers

2.1 创建一个shirts的Controller

  • 创建Controllers文件夹,在该文件夹下创建ShirtsController.cs文件
using Microsoft.AspNetCore.Mvc;namespace WebAPIDemo.Controllers
{[ApiController]public class ShirtsController : ControllerBase{public string GetShirts(){return "Reading all the shirts";   }public string GetShirtById(int id){return $"Reading shirt with ID: {id}";}public string CreateShirt(){return "Creating a new shirt.";}public string UpdateShirt() {return "Updating shirt with ID: {id}";}public string DeleteShirt(int id){return $"Deleting shirt with ID: {id}";}}
}

3. Routing

3.1 使用和创建MapControllers

  1. Program.cs里添加rout的中间件

在这里插入图片描述

  1. 在Controller里,直接使用特性标记routing
using Microsoft.AspNetCore.Mvc;namespace WebAPIDemo.Controllers
{[ApiController]public class ShirtsController : ControllerBase{[HttpGet("/shirts")]public string GetShirts(){return "Reading all the shirts";   }[HttpGet("/shirts/{id}")]public string GetShirtById(int id){return $"Reading shirt with ID: {id}";}[HttpPost("/shirts")]public string CreateShirt(){return "Creating a new shirt.";}[HttpPut("/shirts/{id}")]public string UpdateShirt() {return "Updating shirt with ID: {id}";}[HttpDelete("/shirts/{id}")]public string DeleteShirt(int id){return $"Deleting shirt with ID: {id}";}}
}

3.2 使用Routing的模板语言

  1. 在上面我们给每个Controller都使用一个路由,这样代码冗余,我们可以使用模板来指定rout;

在这里插入图片描述

  • 这样我们可以直接用过https://localhost:7232/shirts 进行访问shirts就是控制器的名称
  1. 如果我们想通过https://localhost:7232/api/shirts进行访问的话,修改模板routing

在这里插入图片描述

4. Mould Binding

将Http request和 Controller里的 parameter绑定起来
在这里插入图片描述

4.1 指定数据的来源

4.1.1 给Request请求添加
1. FromRoute
  • 指定这个参数必须是从https://localhost:7232/api/shirts/2/red从路由里来,如果不是,则报错
[HttpGet("{id}/{color}")]
public string GetShirtById(int id,[FromRoute]string color)
{return $"Reading shirt with ID: {id},color is {color}";
}
2. FromQuery
  • 必须通过QueryString的形式提供:https://localhost:7232/api/shirts/2?color=red
 [HttpGet("{id}/{color}")]public string GetShirtById(int id,[FromQuery]string color){return $"Reading shirt with ID: {id},color is {color}";}
3. FromHeader
  • 必须通过请求头来传递,且Key是Name
[HttpGet("{id}/{color}")]
public string GetShirtById(int id,[FromHeader(Name="color")]string color)
{return $"Reading shirt with ID: {id},color is {color}";
}

在这里插入图片描述

4.1.2 给Post请求添加
  • 在webapp里创建一个新的文件夹Models,并且添加一个Shirts,cs
namespace WebAPIDemo.Models
{public class Shirt{public int ShirtId { get; set; }public string? Brand { get; set; }   public string? Color { get; set; }public int Size { get; set; }public string? Gender { get; set; }public double Price { get; set; }}
}
1. FromBody
  • 从请求体里来
[HttpPost]
public string CreateShirt([FromBody]Shirt shirt)
{return "Creating a new shirt.";
}

在这里插入图片描述

2. FromForm
  • 通过表格形式传递
[HttpPost]
public string CreateShirt([FromForm]Shirt shirt)
{return "Creating a new shirt.";
}

在这里插入图片描述

5. Mould Validation

5.1 添加Model Validation

  • Models/Shirts.cs类里添加验证,如果没有给出必须的参数,请求会报错400
using System.ComponentModel.DataAnnotations;namespace WebAPIDemo.Models
{public class Shirt{[Required]public int ShirtId { get; set; }[Required]public string? Brand { get; set; }   public string? Color { get; set; }public int Size { get; set; }[Required]public string? Gender { get; set; }public double Price { get; set; }}
}

5.2 添加自定义的Validation

  1. Models文件夹里,添加Validations文件夹,并且添加文件Shirt_EnsureCorrectSizingAttribute.cs
using System.ComponentModel.DataAnnotations;
using WebAPIDemo.Models;namespace WebApp.Models.Validations
{public class Shirt_EnsureCorrectSizingAttribute : ValidationAttribute{protected override ValidationResult? IsValid(object? value, ValidationContext validationContext){var shirt = validationContext.ObjectInstance as Shirt;if (shirt != null && !string.IsNullOrWhiteSpace(shirt.Gender)){if (shirt.Gender.Equals("men", StringComparison.OrdinalIgnoreCase) && shirt.Size < 8){return new ValidationResult("For men's shirts, the size has to be greater or equal to 8.");}else if (shirt.Gender.Equals("women", StringComparison.OrdinalIgnoreCase) && shirt.Size < 6){return new ValidationResult("For women's shirts, the size has to be greater or equal to 6.");}}return ValidationResult.Success;}}
}
  1. 我们验证的是Size,所以在Model里的Size添加我们自定义的Attribute
[Shirt_EnsureCorrectSizing]
public int Size { get; set; }

6. WebApi Return Types

6.1 直接返回对象

  • 创建一个List,存放所有的Shirt实例,返回一个Shirt类型
    在这里插入图片描述
  • 通过id访问https://localhost:7232/api/shirts/1, 返回一个json
{shirtId: 1,brand: "My Brand",color: "Blue",size: 10,gender: "Men",price: 30
}

6.2 返回多类型

  • 如果返回多类型,就不能指定具体返回的类型,需要返回一个IActionResult
[HttpGet("{id}")]
public IActionResult GetShirtById(int id)
{if (id <= 0){return BadRequest("Invalid shirt ID");}var shirt = shirts.FirstOrDefault(x => x.ShirtId == id);if( shirt == null){return NotFound();}return Ok(shirt);
}

7. Action filter

  • 使用Action filter进行data validation

7.1 创建filter

  1. 创建Filters文件夹,并且创建Shirt_ValidateShirtId.cs类,并且添加对ShortId的验证
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;
using WebAPIDemo.Models.Repositories;namespace WebAPIDemo.Filters
{public class Shirt_ValidateShirtIdFilterAttribute : ActionFilterAttribute{public override void OnActionExecuting(ActionExecutingContext context){base.OnActionExecuting(context);var shirtId = context.ActionArguments["id"] as int?;if (shirtId.HasValue){if (shirtId.Value <= 0){context.ModelState.AddModelError("ShirtId", "ShirtId is invalid.");var problemDetails = new ValidationProblemDetails(context.ModelState){Status = StatusCodes.Status400BadRequest};context.Result = new BadRequestObjectResult(problemDetails);}else if (!ShirtRepository.ShirtExists(shirtId.Value)){context.ModelState.AddModelError("ShirtId", "Shirt doesn't exist.");var problemDetails = new ValidationProblemDetails(context.ModelState){Status = StatusCodes.Status404NotFound};context.Result = new NotFoundObjectResult(problemDetails);}}}}
}
  1. 使用添加的filter,对 id进行验证
[HttpGet("{id}")]
[Shirt_ValidateShirtIdFilter]
public IActionResult GetShirtById(int id)
{return Ok(ShirtRepository.GetShirtById(id));
}

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/pingmian/64637.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Java操作Redis-Jedis

介绍 前面我们讲解了Redis的常用命令&#xff0c;这些命令是我们操作Redis的基础&#xff0c;那么我们在 java程序中应该如何操作Redis呢&#xff1f;这就需要使用Redis的Java客户端&#xff0c;就如同我们使 用JDBC操作MySQL数据库一样。 Redis 的 Java 客户端很多&#xff0…

Vue3 + Element-Plus + vue-draggable-plus 实现图片拖拽排序和图片上传到阿里云 OSS 父组件实现真正上传(最新保姆级)

Vue3 Element-Plus vue-draggable-plus 实现图片拖拽排序和图片上传到阿里云 OSS&#xff08;最新保姆级&#xff09;父组件实现真正上传 1、效果展示2、UploadImage.vue 组件封装3、相关请求封装4、SwiperConfig.vue 调用组件5、后端接口 1、效果展示 如果没有安装插件&…

将 Ubuntu 22.04 LTS 升级到 24.04 LTS

Ubuntu 24.04 LTS 将支持 Ubuntu 桌面、Ubuntu 服务器和 Ubuntu Core 5 年&#xff0c;直到 2029 年 4 月。 本文将介绍如何将当前 Ubuntu 22.04 系统升级到最新 Ubuntu 24.04 LTS版本。 备份个人数据 以防万一&#xff0c;把系统中的重要数据自己备份一下~ 安装配置SSH访问…

宝塔SSL证书申请失败,报错:申请SSL证书错误 module ‘OpenSSL.crypto‘ has no attribute ‘sign‘(已解决)

刚安装宝塔申请SSL就报错&#xff1a;申请SSL证书错误 module OpenSSL.crypto has no attribute sign 面板、插件版本&#xff1a;9.2.0 系统版本&#xff1a;Alibaba Cloud Linux 3.2104 LTS 问题&#xff1a;申请SSL证书错误 module OpenSSL.crypto has no attribute sign…

<mutex>注释 12:重新思考与猜测、补充锁的睡眠与唤醒机制,结合 linux0.11 操作系统代码的辅助(下)

&#xff08;60&#xff09;继续分析&#xff0c;为什么 timed_mutex 可以拥有准时的等待时间&#xff1a; 逐步测试&#xff1a; 以及&#xff1a; 以及&#xff1a; 以及&#xff1a; 上面的例子里之所以这么编写。无论 timed_mutex 里的定时等待函数&#xff0c;还是 条件…

【MySQL】InnoDB引擎中的Compact行格式

目录 1、背景2、数据示例3、Compact解释【1】组成【2】头部信息【3】隐藏列【4】数据列 4、总结 1、背景 mysql中数据存储是存储引擎干的事&#xff0c;InnoDB存储引擎以页为单位存储数据&#xff0c;每个页的大小为16KB&#xff0c;平时我们操作数据库都是以行为单位进行增删…

Kylin麒麟操作系统 | 网络链路聚合配置(team和bond)

目录 一、理论储备1. 链路聚合 二、任务实施1. team模式2. bond模式 一、理论储备 1. 链路聚合 链路聚合是指将多个物理端口捆绑在一起&#xff0c;形成一个逻辑端口&#xff0c;以实现出/入流量在各成员端口中的负载分担。链路聚合在增加链路带宽、实现链路传输弹性和冗余等…

Linux中用户和用户管理详解

文章目录 Linux中用户和用户管理详解一、引言二、用户和用户组的基本概念1、用户账户文件2、用户组管理 三、用户管理操作1、添加用户2、设置用户密码3、删除用户 四、用户组操作1、创建用户组2、将用户添加到用户组 五、总结 Linux中用户和用户管理详解 一、引言 在Linux系统…

多进程并发跑程序:pytest-xdist记录

多进程并发跑程序&#xff1a;pytest-xdist记录 pytest -s E:\testXdist\test_dandu.py pytest -s testXdist\test_dandu.py pytest -s &#xff1a;是按用例顺序依次跑用例 pytest -vs -n auto E:\testXdist\test_dandu.py pytest -vs -n auto&#xff0c;auto表示以全部进程…

笔记--(Shell脚本04)、循环语句与函数

循环语句 1、for语句的结构 for 变量名 in 取值列表 do 命令序列 done for 收件人 in 邮件地址列表 do 发送邮件 done for i in {1..10} doecho $i done[rootlocalhost shell]# ./ce7.sh 1 2 ...... 9 101 #!/bin/bash2 3 for i in seq 1 104 do5 echo $i6 done[rootlocal…

用.Net Core框架创建一个Web API接口服务器

我们选择一个Web Api类型的项目创建一个解决方案为解决方案取一个名称我们这里选择的是。Net 8.0框架 注意&#xff0c;需要勾选的项。 我们找到appsetting.json配置文件 appsettings.json配置文件内容如下 {"Logging": {"LogLevel": {"Default&quo…

go引用包生成不了vendor的问题

比如我要引入github.com/jinzhu/gorm这个包. 1. 首先获取包 go get github.com/jinzhu/gorm 这时go.mod文件中也有这个包依赖信息了. 2. 然后构建vendor go mod vendor 结果发现vendor目录下没有生成对应的包, 而且modules.txt也注释掉这个包了. 原因是没有其进行引用, go…

36. Three.js案例-创建带光照和阴影的球体与平面

36. Three.js案例-创建带光照和阴影的球体与平面 实现效果 知识点 Three.js基础 WebGLRenderer WebGLRenderer 是Three.js中最常用的渲染器&#xff0c;用于将场景渲染到网页上。 构造器 new THREE.WebGLRenderer(parameters)参数类型描述parametersobject可选参数&#…

el-table表格嵌套子表格:展开所有内容;对当前展开行内容修改,当前行默认展开;

原文1 原文2 原文3 一、如果全部展开 default-expand-all"true" 二、设置有数据的行打开下拉 1、父table需要绑定两个属性expand-row-key和row-key <el-table:data"tableData":expand-row-keys"expends" //expends是数组&#xff0c;设置…

零基础微信小程序开发——小程序的宿主环境(保姆级教程+超详细)

&#x1f3a5; 作者简介&#xff1a; CSDN\阿里云\腾讯云\华为云开发社区优质创作者&#xff0c;专注分享大数据、Python、数据库、人工智能等领域的优质内容 &#x1f338;个人主页&#xff1a; 长风清留杨的博客 &#x1f343;形式准则&#xff1a; 无论成就大小&#xff0c;…

NOTEBOOK_11 汽车电子设备分享(工作经验)

汽车电子设备分享 摘要 本文主要列出汽车电子应用的一些实验设备和生产设备&#xff0c;部分会给予一定推荐。目录 摘要一、通用工具&#xff1a;二、测量与测试仪器2.1测量仪器2.2无线通讯测量仪器2.3元器件测试仪2.4安规测试仪2.5电源供应器2.6电磁兼容测试设备2.7可靠性环境…

linux centos 7 安装 mongodb7

MongoDB 是一个基于文档的 NoSQL 数据库。 MongoDB 是一个文档型数据库&#xff0c;数据以类似 JSON 的文档形式存储。 MongoDB 的设计理念是为了应对大数据量、高性能和灵活性需求。 MongoDB使用集合&#xff08;Collections&#xff09;来组织文档&#xff08;Documents&a…

opengl 着色器 (四)最终章收尾

颜色属性 在前面的教程中&#xff0c;我们了解了如何填充VBO、配置顶点属性指针以及如何把它们都储存到一个VAO里。这次&#xff0c;我们同样打算把颜色数据加进顶点数据中。我们将把颜色数据添加3个float值到vertices数组。我们将把三角形的三个角分别指定为红色、绿色和蓝色…

矩阵在资产收益(Asset Returns)中的应用:以资产回报矩阵为例(中英双语)

本文中的例子来源于&#xff1a; 这本书&#xff0c;网址为&#xff1a;https://web.stanford.edu/~boyd/vmls/ 矩阵在资产收益(Asset Returns)中的应用&#xff1a;以资产回报矩阵为例 在量化金融中&#xff0c;矩阵作为一种重要的数学工具&#xff0c;被广泛用于描述和分析…

arXiv-2024 | NavAgent:基于多尺度城市街道视图融合的无人机视觉语言导航

作者&#xff1a;Youzhi Liu, Fanglong Yao*, Yuanchang Yue, Guangluan Xu, Xian Sun, Kun Fu 单位&#xff1a;中国科学院大学电子电气与通信工程学院&#xff0c;中国科学院空天信息创新研究院网络信息系统技术重点实验室 原文链接&#xff1a;NavAgent: Multi-scale Urba…