广告

扫码关注官方微信

扫码下载APP
返回顶部
首页 > 资讯 > 后端开发 > ASP.NET >使用ASP.NET Web API构建Restful API
  • 400

0
分享到

使用ASP.NET Web API构建Restful API

2024-04-02 19:04:59 400人浏览 薄情痞子
摘要

目录一、前言二、获取所有数据三、获取详情四、新增数据五、修改数据六、删除数据七、特性路由(1) 基本路由映射(2) 路由映射参数(3) 多重特性路由(4) 缺省参数路由(5) 参数约

一、前言

RESTful api 是基于Http协议产生的一种相对简单的API设计方案；

RESTful 的核心是 everything is a “resource”，所有的HTTP action，都应该是相应resource上可以被操作和处理的，而API 就是对资源的管理操作，而这个具体操作是由 HTTP action 指定的。

使用HTTP的GET、POST、DELETE、PUT来表示对于资源的增删改查。

  • GET：读取（Read）
  • POST：新建（Create）
  • PUT：更新（Update）
  • DELETE：删除（Delete）

学习资料准备：

（1）用于测试的实体类：

public class Student
{
    public string StuNo { get; set; }    //学号
    public string StuName { get; set; }  //姓名
    public string StuSex { get; set; }   //性别
}

（2）模拟的测试数据（编写在webapi类的构造函数中）：

public static List<Student> StuList { get; set; }
public ServerController()
{
    StuList = new List<Student>();
    StuList.Add(new Student { StuNo = "001", StuName = "孙悟空", StuSex = "男" });
    StuList.Add(new Student { StuNo = "002", StuName = "猪八戒", StuSex = "男" });
    StuList.Add(new Student { StuNo = "003", StuName = "白骨精", StuSex = "女" });
}

二、获取所有数据

API接口：

[HttpGet]
public List<Student> GetList([FromBody]dynamic obj)
{
	return StuList;
}

三、获取详情

API接口：

[HttpGet]
public Student GetDetail(string id)
{
	Student stu = StuList.SingleOrDefault(p => p.StuNo.Equals(id));
	return stu;
}

四、新增数据

API接口：

[HttpPost]
public IHttpActionResult Add([FromBody] Student stu)
{
    StuList.Add(stu);
    return JSON(new { msg = "添加成功!",data=StuList });
}

五、修改数据

API接口：

[HttpPut]
public IHttpActionResult Update(string id, [FromBody] Student stu)
{
    Student model = StuList.SingleOrDefault(p => p.StuNo.Equals(id));
    if (model == null)
    	return json(new { msg = "修改的数据不存在!" });
    model.StuNo = stu.StuNo;
    model.StuName = stu.StuName;
    model.StuSex = stu.StuSex;
    return Json(new { msg = "修改成功!", data = model });
}

六、删除数据

API接口：

[HttpDelete]
public IHttpActionResult Delete(string id)
{
    Student model = StuList.SingleOrDefault(p => p.StuNo.Equals(id));
    if (model == null)
    	return Json(new { msg = "删除的数据不存在!" });
    StuList.Remove(model);
    return Json(new { msg = "删除成功!", data = StuList });
}

七、特性路由

(1) 基本路由映射

API接口：

[HttpGet]
[Route("api/Route/Basic")]
public IHttpActionResult GetBasic()
{
	return Json(new { msg = "测试基本的特性路由!" });
}

接口访问地址：

http://localhost:60650/api/Route/Basic

(2) 路由映射参数

API接口：

[HttpGet]
[Route("api/Route/Param/{id}/{name}")]
public IHttpActionResult Get2(string id,string name)
{
	return Json(new { msg = "测试路由映射参数!",data = new { id= id,name=name } });
}

接口访问地址：

http://localhost:60650/api/Route/Param/001/孙悟空

(3) 多重特性路由

API接口：

[HttpGet]
[Route("api/Route/Multiple1/{id}/{name}")]
[Route("api/Route/Multiple2/{id}/{name}")]
public IHttpActionResult Get3(string id,string name)
{
	return Json(new { msg = "测试多重特性路由!",data = new { id= id,name=name } });
}

接口访问地址：

http://localhost:60650/api/Route/Multiple1/001/孙悟空

或

http://localhost:60650/api/Route/Multiple2/001/孙悟空

(4) 缺省参数路由

API接口：

[HttpGet]
[Route("api/Route/Default/{id}/{name?}")]
public IHttpActionResult Get4(string id, string name="孙悟空")
{
    return Json(new { msg = "测试缺省参数路由!", data = new { id = id, name = name } });
}

或

[HttpGet]
[Route("api/Route/Default/{id}/{name=孙悟空}")]
public IHttpActionResult Get4(string id, string name)
{
	return Json(new { msg = "测试缺省参数路由!", data = new { id = id, name = name } });
}

接口访问地址：

http://localhost:60650/api/Route/Default/001

(5) 参数约束路由

asp.net WEB API内置约束有下面这些：

{x:alpha} 约束大小写英文字母
{x:bool}
{x:datetime}
{x:decimal}
{x:double}
{x:float}
{x:guid}
{x:int}
{x:length(6)}
{x:length(1,20)} 约束长度范围
{x:long}
{x:maxlength(10)}
{x:min(10)}
{x:range(10,50)} //约束值的范围
{x:regex(正则表达式)}

可以设置多个约束：

[Route("api/Route/orders/{id:int:min(1)}")]

API接口：

[HttpGet]
[Route("api/Route/Check/{id:range(1,100)}/{name}")]
public IHttpActionResult Get5(int id, string name)
{
	return Json(new { msg = "测试参数约束路由!", data = new { id = id, name = name } });
}

接口访问地址：（以下地址可以正常访问接口）

http://localhost:60650/api/Route/Check/11/孙悟空

接口访问地址：（以下地址无法访问接口）

http://localhost:60650/api/Route/Check/101/孙悟空

(6) 通配符(*)路由变量

API接口：

[HttpGet]
[Route("api/Route/Date/{id:range(1,100)}/{name}/{*birthday}")]
public IHttpActionResult Get6(int id, string name,DateTime birthday)
{
	return Json(new { msg = "*使用!", data = new { id = id, name = name,birthday = birthday.ToString("yyyy年MM月dd日") } });
}

接口访问地址：

http://localhost:60650/api/Route/Date/1/jack/1988-8-8

接口访问地址：（此地址如果在路由中没有*则无法访问，因为程序会认为“1988/8/8”是三个参数，而不是一个参数）

http://localhost:60650/api/Route/Date/1/jack/1988/8/8

(7) 路由映射复杂参数

给实体类添加特性使其支持绑定：

[ModelBinder]
public class Student
{
	public string StuNo { get; set; }    //学号
	public string StuName { get; set; }  //姓名
	public string StuSex { get; set; }   //性别
}

方案一API接口：

[HttpGet]
[Route("api/Route/Class/{stu.StuNo}/{stu.StuName}/{stu.StuSex}")]
public IHttpActionResult Get7(Student stu)
{
	return Json(new { msg = "路由映射复杂参数!", data = stu });
}

方案一接口访问地址：

http://localhost:60650/api/Route/Class/001/jack/man

方案二API接口：

[HttpGet]
[Route("api/Route/Class")]
public IHttpActionResult Get7(Student stu)
{
	return Json(new { msg = "路由映射复杂参数!", data = stu });
}

方案二接口访问地址：

http://localhost:60650/api/Route/Class?stu.StuNo=001&stu.StuName=jack&stu.StuSex=man

(8) 路由前缀

在控制器类上定义路由前缀：

[RoutePrefix("api/Prefix")]
public class PrefixController : ApiController
{

}

路由前缀API接口：

[Route("Basic")]
public IHttpActionResult Get1()
{
	return Json(new { msg = "测试路由前缀!" });
}

接口访问地址：

http://localhost:60650/api/Prefix/Basic

取消路由前缀API接口：

[Route("~/api/Cancel/Basic")]  //通过~/取消路由前缀
public IHttpActionResult Get2()
{
	return Json(new { msg = "取消路由前缀!" });
}

接口访问地址：

http://localhost:60650/api/Cancel/Basic

到此这篇关于使用ASP.net Web API构建Restful API的文章就介绍到这了。希望对大家的学习有所帮助，也希望大家多多支持编程网。

点击免费下载>>软考高级考试备考技巧/历年真题/备考精华资料

--结束END--

本文标题: 使用ASP.NET Web API构建Restful API

本文链接: https://www.lsjlt.com/news/147371.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑，方便收藏和打印～

下载Word文档
去做题
猜你喜欢
  • 使用ASP.NET Web API构建Restful API
    目录一、前言二、获取所有数据三、获取详情四、新增数据五、修改数据六、删除数据七、特性路由(1) 基本路由映射(2) 路由映射参数(3) 多重特性路由(4) 缺省参数路由(5) 参数约...
    99+
    2022-11-13
  • ASP.NET Core构建OData查询Restful API
    目录前言：一、建构 OData 实体模型二、配置 OData 中间件三、OData 实现 Restful API 查询参考文档前言： 本文使用 .NET Core SDK 3.1 的...
    99+
    2022-11-13
  • ASP.NET Core怎么构建OData查询Restful API
    这篇文章主要讲解了“ASP.NET Core怎么构建OData查询Restful API”，文中的讲解内容简单清晰，易于学习与理解，下面请大家跟着小编的思路慢慢深入，一起来研究和学习“ASP.NET Core怎...
    99+
    2023-06-30
  • ASP.NET Core之Web API怎么创建
    这篇文章主要介绍“ASP.NET Core之Web API怎么创建”的相关知识，小编通过实际案例向大家展示操作过程，操作方法简单快捷，实用性强，希望这篇“ASP.NET Core之Web API怎么创...
    99+
    2023-06-30
  • 使用Go和Laravel构建RESTful API的最佳实践
    RESTful API是现代Web应用程序中不可或缺的一部分。它们使得Web应用程序能够以统一的方式与客户端通信，这样客户端就可以使用各种语言和平台来访问和使用Web应用程序。本文将介绍。 一、Go Go是一种由谷歌开发的编程语言，被广泛...
    99+
    2023-08-16
    laravel 学习笔记 shell
  • 基于Go语言构建RESTful API服务
    目录什么是 RESTful API 一个简单的 RESTful API RESTful JSON API Gin 框架 引入 Gin 框架 使用 Gin 框架 新增一个用户 获取特定...
    99+
    2022-11-12
  • PHP 和 Spring Boot：如何快速构建 RESTful API？
    RESTful API 是现代应用程序的核心组件之一。它们允许应用程序之间通过 HTTP 协议进行通信，并提供了一种通用、灵活和可扩展的方式来访问和操作数据。在本文中，我们将探讨如何使用 PHP 和 Spring Boot 快速构建 RE...
    99+
    2023-07-02
    spring 文件 javascript
  • Spring MVC利用Swagger2如何构建动态RESTful API详解
    前言本文主要给大家介绍了关于Spring MVC用Swagger2构建动态RESTful API的相关内容，当多终端（WEB/移动端）需要公用业务逻辑时，一般会构建 RESTful 风格的服务提供给多终端使用。为了减少与对应终端开发团队频繁...
    99+
    2023-05-30
    swagger2 springmvc restful
  • 微服务云架构-Swagger2构建强大的RESTful API文档
    在完成了上述配置后，其实已经可以生产文档内容，但是这样的文档主要针对请求本身，而描述主要来源于函数等命名产生，对用户并不友好，我们通常需要自己增加一些说明来丰富文档内容。如下所示，我们通过@ApiOperation注解来给API增加说明、通...
    99+
    2023-06-05
  • 你知道如何在 PHP 和 JavaScript 中使用 Spring 构建 RESTful API 吗？
    在当今的互联网时代，RESTful API 已经成为了开发者们构建 Web 应用程序的标准之一。而 Spring 框架又是一个非常流行的开发框架，它提供了一系列的工具和技术，可以帮助开发者更加高效地构建 RESTful API。本文将介绍如...
    99+
    2023-11-03
    javascript spring api
  • Django REST框架：如何使用HTTP API构建Web服务？
    Django REST框架是一个基于Django的强大的Web API框架，它使得构建Web服务变得更加容易和快速。本文将介绍如何使用Django REST框架来构建HTTP API服务。 安装Django REST框架 首先，需要安...
    99+
    2023-11-12
    django http git
  • Node.js中如何使用RESTful API
    本篇文章为大家展示了Node.js中如何使用RESTful API，内容简明扼要并且容易理解，绝对能使你眼前一亮，通过这篇文章的详细介绍希望你能有所收获。Node.js RESTful API现在介绍Nod...
    99+
    2022-10-19
  • Spring Boot集成springfox-swagger2构建restful API的方法教程
    前言之前跟大家分享了Spring MVC集成springfox-swagger2构建restful API，简单写了如何在springmvc中集成swagger2。这边记录下在springboot中如何集成swagger2。其实使用基本相同...
    99+
    2023-05-31
    springboot springfox-swagger2 restful
  • 怎样使用Jwt身份认证保护 Asp.Net Core Web Api
    怎样使用Jwt身份认证保护 Asp.Net Core Web Api，很多新手对此不是很清楚，为了帮助大家解决这个难题，下面小编将为大家详细讲解，有这方面需求的人可以来学习下，希望你能有所收获。网络上有许多资源可以教你如何保护ASP.NET...
    99+
    2023-06-19
  • 如何使用Spring MVC与springfox-swagger2搭建一个restful API
    如何使用Spring MVC与springfox-swagger2搭建一个restful API？针对这个问题，这篇文章详细介绍了相对应的分析和解答，希望可以帮助更多想解决这个问题的小伙伴找到更简单易行的方法。前言在集成springfox-...
    99+
    2023-05-31
    springmvc springfox-swagger2 restful api
  • 使用Node.js实现RESTful API的示例
    RESTful基础概念 REST（Representational State Transfer）描述了一个架构样式的网络系统，它首次出现在 2000 年 Roy Fielding 的博士论文中。在REST...
    99+
    2022-06-04
    示例 js Node
  • 如何使用 Python 框架构建 HTTP API？
    随着互联网的发展，HTTP API 的应用越来越广泛，可以说是现代Web应用的核心组件之一。Python 作为一门流行的编程语言，也有很多优秀的框架可以用于构建 HTTP API。 本文将介绍如何使用 Python 框架 Flask 和 ...
    99+
    2023-10-06
    框架 api http
  • 什么是API？如何在PHP中使用它来构建Web应用程序？
    API，全称应用程序编程接口（Application Programming Interface），是一种用于不同应用程序之间通信的方式。通过API，应用程序可以相互之间共享数据和功能，从而实现更高效、更灵活的开发和应用。在Web应用程序开...
    99+
    2023-06-06
    api shell numpy
  • Python 3.7之使用web api
    1.调用GitHub的公共API #需要提前安装requests 包 import requests url = 'https://api.github.com/search/repositoriesq=language:pytho...
    99+
    2023-01-31
    Python api web
  • VS2022（Visual Studio）发布ASP.NET Core Web API应用到Web服务器（IIS）
    概述 写完代码后，最常用、简单的发布方式，就是将应用发布到文件夹，然后将publish文件夹复制到要部署的机器上（本地、局域网服务器、云服务器等）。 但是在实际工作中，可能会遇到需要频繁地发布，以使应...
    99+
    2023-09-26
    服务器 visual studio
软考高级职称资格查询
软考职称历年真题下载
软考职称资料下载
热门wiki
近期文章
推荐阅读
热门问答
热门标签
编程网，编程工程师的家园，是目前国内优秀的开源技术社区之一，形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容，为IT开发者提供了一个发现、使用、并交流开源技术的平台。

  • 官方手机版

  • 微信公众号

  • 商务合作