Web API学习笔记（六）——路由（Routing）

已于 2022-12-21 15:28:33 修改
阅读量1.5k 收藏 7
点赞数 1
分类专栏： Web API 学习笔记 文章标签： 学习 c# web 后端
于 2022-09-05 17:22:54 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_45724919/article/details/126704280
版权

1.什么是路由?

1.路由是将传入http请求（URL）映射到特定资源的过程（a action method）。
2.我们可以使用唯一的URL访问任何的资源。
3.一个资源可以有多个唯一的URL。
4.多个资源不能具有相同的URL。

2.如何启用路由?

1.在Asp.Net Core Web应用中，我们可以通过中间件启用路由(routing)。
2.我们需要在http管线中插入以下两个中间件
·UseRouting()
·UseEndpoint()
也就是在Startup.cs脚本Configure方法中的这两句代码：

 app.UseRouting();

 app.UseEndpoints(endponits =>
 {
     endponits.MapControllers();
 });

3.在事件的Action方法上设置路由

新建一个value控制器，如果不知道如何创建，请参考：Web API学习笔记（四）——添加一个控制器类(Controller class)
ValuesController.cs脚本代码如下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;

namespace MyWebApi.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class ValuesController : ControllerBase
    {
        [Route("get1")]
        public string Get1()
        {
            return "I am Get1";
        }

        [Route("get2")]
        public string Get2()
        {
            return "I am Get2";
        }
    }
}

记得运行时把Startup.cs脚本Configure方法中有中间件方法的地方给注释掉，不然可能会出现一些阻塞。
运行结果：
get1:
在这里插入图片描述
get2:
在这里插入图片描述
Routing里也可改为以下模版：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;

namespace MyWebApi.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class ValuesController : ControllerBase
    {
        [Route("get/1")]
        public string Get1()
        {
            return "I am Get1";
        }

        [Route("get/2")]
        public string Get2()
        {
            return "I am Get2";
        }
    }
}

运行结果：
1:
在这里插入图片描述
2:
在这里插入图片描述

4.在路由中使用变量

4.1 使用单个变量
继续在ValuesController加入GetId方法，如下

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;

namespace MyWebApi.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class ValuesController : ControllerBase
    {
        [Route("get/1")]
        public string Get1()
        {
            return "I am Get1";
        }

        [Route("get/2")]
        public string Get2()
        {
            return "I am Get2";
        }

        [Route("students/{id}")]
        public string GetId(int id)
        {
            return "Get students id :" + id;
        }
    }
}

运行结果：
在这里插入图片描述
4.3 使用多个变量
继续在ValuesController加入GetIdAndScore方法，如下

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;

namespace MyWebApi.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class ValuesController : ControllerBase
    {
        [Route("get/1")]
        public string Get1()
        {
            return "I am Get1";
        }

        [Route("get/2")]
        public string Get2()
        {
            return "I am Get2";
        }

        [Route("students/{id}")]
        public string GetId(int id)
        {
            return "Get students id :" + id;
        }

        [Route("students/{id}/score/{score}")]
        public string GetIdAndScore(int id, int score)
        {
            return "Get students id :" + id + " score:" + score;
        }
    }
}

运行结果：
在这里插入图片描述

4.4 使用Query String
继续在ValuesController加入SearchStudents方法，如下

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;

namespace MyWebApi.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class ValuesController : ControllerBase
    {
        [Route("get/1")]
        public string Get1()
        {
            return "I am Get1";
        }

        [Route("get/2")]
        public string Get2()
        {
            return "I am Get2";
        }

        [Route("students/{id}")]
        public string GetId(int id)
        {
            return "Get students id :" + id;
        }

        [Route("students/{id}/score/{score}")]
        public string GetIdAndScore(int id, int score)
        {
            return "Get students id :" + id + " score:" + score;
        }

        [Route("search")]
        public string SearchStudents(int id,string name,int score)
        {
            return string.Format("Id:{0}\nname:{1}\nscore:{2}",id,name,score);
        }
    }
}

使用Query String 进行访问：http://localhost:5000/api/values/search?id=15&name=Lice&score=90
运行结果：
在这里插入图片描述

5.为单个资源设置多个URL

 [Route("get/1")]
 [Route("get1")]
 public string Get1()
 {
     return "I am Get1";
 }

6.多个资源相同的URL（错误示例）

[Route("get/1")]
        [Route("get1")]
        [Route("get")]
        public string Get1()
        {
            return "I am Get1";
        }

        [Route("get/2")]
        [Route("get")]
        public string Get2()
        {
            return "I am Get2";
        }

在这里插入图片描述
之前已经说过了，多个资源不能具有相同的URL。

7.路由中的令牌替换

[Route("get/1")]
[Route("get1")]
[Route("[controller]/[action]")]
public string Get1()
{
    return "I am Get1";
}

[controller]这里填控制器的名称
[action]这里填方法的名称
运行示例：
在这里插入图片描述

8.在控制器级别设置基本路由

也就是在控制器类上加上[Route(“[controller]/[action]”)]
如图所示
在这里插入图片描述
然后把方法名上的路由都注释掉就可以了，按照控制器名称/方法名都方法进行URL访问，Web API提供了多种路由配置的方法，学到这儿，大家可按照自己的喜好来配置路由。

9.路由约束验证路由变量

1.约束类型：int,bool,datatime,double,float, etc.
新建一个Books控制器
BooksController.cs代码如下

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;

namespace MyWebApi.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class BooksController : ControllerBase
    {
        [Route("{id}")]
        public string GetIntId(int id)
        {
            return "Int id is " + id;
        }

        [Route("{id}")]
        public string GetStringId(string id)
        {
            return "String id is " + id;
        }
    }
}

若直接运行测试则会报以下错：
在这里插入图片描述
加了约束后代码如下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;

namespace MyWebApi.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class BooksController : ControllerBase
    {
        [Route("{id:int}")]
        public string GetIntId(int id)
        {
            return "Int id is " + id;
        }

        [Route("{id}")]
        public string GetStringId(string id)
        {
            return "String id is " + id;
        }
    }
}

运行结果：
int:
在这里插入图片描述
string:
在这里插入图片描述
2.约束最小、最大值(Min:min(number),Max:max(number))
对于BooksController.cs脚本GetIntId方法增加约束如下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;

namespace MyWebApi.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class BooksController : ControllerBase
    {
        [Route("{id:int:min(10):max(100)}")]
        public string GetIntId(int id)
        {
            return "Int id is " + id;
        }

        [Route("{id}")]
        public string GetStringId(string id)
        {
            return "String id is " + id;
        }
    }
}

运行结果：
在这里插入图片描述
做了约束之后在99满足10-100范围内为Int.
在这里插入图片描述
做了约束之后在999不满足10-100范围内为String.

3.约束最小、最大长度、固定长度（MinLength:minlength(10),MaxLength:maxlength(20)、Length:length(15)）
对于BooksController.cs脚本修改如下

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;

namespace MyWebApi.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class BooksController : ControllerBase
    {
        [Route("{id:int:min(10):max(100)}")]
        public string GetIntId(int id)
        {
            return "Int id is " + id;
        }

        [Route("{id:minLength(5)}")]
        public string GetStringId(string id)
        {
            return "String id is " + id;
        }
    }
}

测试结果：
当长度小于5时，不满足条件
在这里插入图片描述
当长度大于5时，满足条件
在这里插入图片描述
MaxLength和Length可以此类推。

4.范围(Range:range(10,15))
这个用法效果和最大最小值约束作用差不多，如果是range(10,15)实际都是闭区间[10,15]。

        [Route("{id:int:range(10,15)}")]
        public string GetIntRangeId(int id)
        {
            return "Int range id is " + id;
        }

5.字母约束（Alpha:alpha）

        [Route("{id:length(5):alpha}")]
        public string GetAlphaId(string id)
        {
            return "Int range id is " + id;
        }

6.正则约束（regex）

        [Route("{id:regex(a(b|c))}")]
        public string GetRegexId(string id)
        {
            return "Regex id is " + id;
        }
鹏易灵
关注
  • 1
    点赞
  • 踩
  • 7
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
HCIE-Datacom SR segment routing段路由学习笔记
03-07
HCIE-Datacom SR segment-routing段路由学习笔记
adhoc_routing-master_路由强化学习_强化学习_强化学习路由_
09-30
adhoc_routing-master 基于强化学习的无线自组织网络路由协议实现
Web Api Route属性定义
极客神殿
02-07 1299
ASP.NET Web API路由，简单来说，就是把客户端请求映射到对应的Action上的过程。在”ASP.NET Web API实践系列03,路由模版, 路由惯例, 路由设置”一文中，体验了通过模版、惯例、HTTP方法来设置路由，这种做法的好处是把路由模版统一放在了App_Start文件夹下的WebApiConfig类中，方便管理，但缺点是不够灵活。 REST把一切都看成资源，有时候，一个资源
WebApi自定义路由 Route 与 RoutePrefix 的用法
Fanbin168的专栏
09-04 1万+
1 public class ValuesController : ApiController { // GET api/values public IEnumerable Get() { return new string[] { "value1", "value2" ,"ABC"}; } // GET api/values/5
C# webpai 路由详解
begeneral的专栏
09-19 2267
关于MVC的路由，相信大家都很熟悉了。我们常见的路由是：{controller}/{action}/{id}，这个默认的路由能满足我们日常的需要，因为这个路由非常简单，所以这里就不做介绍了，今天我们重点介绍一下Route和RoutePrefix这两个路由特性 直接上代码吧： [RoutePrefix("values")] public class ValuesController : ApiController { [HttpGet] [Route("G
ASP.NET WebApi 路由配置
milijiangjun的博客
10-25 896
一、路由介绍 ASP.NET Web API路由是整个API的入口。我们访问某个资源就是通过路由映射找到对应资源的URL。通过URL来获取资源的。 对于ASP.NET Web API内部实现来讲，我们的请求最终将定位到一个具体的Action上。所以说，ASP.NET Web API路由就是把客户端请求映射到对应的Action上的过程。 二、两种路由模式 2.1 模
WebApi路由机制详解——看完不会用你打我
热门推荐
xiaouncle的博客
11-12 4万+
随着前后端分离的大热，WebApi在项目中的作用也是越来越重要，由于公司的原因我之前一直没有机会参与前后端分离的项目，但WebApi还是要学的呀，因为这东西确实很有用，可单独部署、与前端和App交互都很方便，既然有良好的发展趋势，我们当然应该顺势而为——搞懂WebApi！ 从MVC到WebApi，路由机制一直都在其中扮演着重要的角色。 它可以很简单：如果你只需要会用一些简单的路由，如/Home...
C# webAPI ——请求路由
qq_43886548的博客
06-07 967
Web API 中的路由
.Net Core 路由处理
weixin_48967543的博客
04-10 628
　　用户请求接口路由，应用返回处理结果。应用中如何匹配请求的数据呢？为何能如此精确的找到对应的处理方法？今天就谈谈这个路由。路由负责匹配传入的HTTP请求，将这些请求发送到可以执行的终结点。终结点在应用中进行定义并且在应用启动的时候进行配置，也就是在中间件中进行处理。 路由基础知识优惠券 https://www.fenfaw.cn/ 　　在项目新建的时候都会自动生成路由相关代码。在Startup.Configure中的中间件管道注册的。主要涉及到的则是UseRouting和UseEndpoints中间件。.
C# WebAPI 路由配置
书中自有妍如玉的博客
03-03 1709
背景：在开发项目的过程中，新创建了一个controller，发现vs会给我们直接在controller头添加前缀，比如[Route("api/[controller]")],即在访问接口的时候会变成http://localhost:8000/api/values，但是如果控制器有很多个，或者要进行版本迭代时，我们会发现痛苦的时刻降临了，要一个一个的修改。如果在这个时候可以进行全局配置前缀那真是福利呀，修改一处即可。ApiExplorerModel:包括描述信息，群组信息，可见性等。
ASP.NET Core 基础（九）——路由Routing
catshitone的专栏
04-20 1488
此文是在官方文档的基础上做的个人笔记，一些简单的内容就没用再列出来了，参考官方文档：https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/routing?view=aspnetcore-5.0 定义：路由是负责匹配传入的http请求，然后进行发送到应用的可执行终结点（代码处理单元）。 本文只介绍较低级别的路由信息，有关MVC中的路由和Razor中的路由参考： https://docs.microsoft.com/zh-cn/aspnet/c.
Segment Routing学习笔记.doc
04-27
Segment Routing学习笔记 Segment Routing是一种源路由机制，其基于转发平面分为两种：SR-MPLS、SR v6 SR-MPLS 产生背景 基本原理 SR隧道建立过程 业务应用 可靠性
在Azure上创建Web API服务以获取推文
04-04
创建获取推文的Web API服务并将其托管在Windows Azure上。
Wakin XieSir 华为路由交换Routing-Switch 学习笔记
12-22
Wakin XieSir 华为路由交换Routing&Switch 学习笔记
JAVA 学习·泛型（二）——通配泛型
最新发布
wr114514的博客
05-02 629
介绍了Java泛型中的重要知识点——通配泛型及其应用。
限流的学习
weixin_43675252的博客
05-01 247
限流算法：滑动窗口算法滑动日志算法漏桶算法令牌桶算法。
力扣数据库题库学习（4.28日）--1587. 银行账户概要 II
Jesse_Kyrie的博客
04-28 222
对于力扣题1587. 银行账户概要 II的解答，提供解题思路与解题方法，知识点为:1. GROUP BY 2. SUM 3. LEFT JOIN 4. HAVING
党务学习|基于SprinBoot+vue的大学生党务学习平台(源码+数据库+文档)
伟庭的博客
04-27 765
大学生党务学习平台管理系统按照操作主体分为管理员和用户。用户的功能等。该系统采用了Mysql数据库，Java语言，Spring Boot框架等技术进行编程实现。大学生党务学习平台管理系统可以提高大学生党务学习平台信息管理问题的解决效率，优化大学生党务学习平台信息处理流程，保证大学生党务学习平台信息数据的安全，它是一个非常可靠，非常安全的应用程序。大学生党务学习平台管理系统；入党申请,党课Mysql数据库；Java语言。
[C++基础学习]----04-一维数组和二维数组详解
一伦明悦的博客
05-02 226
一维数组和二维数组是在编程中常用的数据结构，它们具有不同的特点和适用场景。1、一维数组一维数组是一种线性结构，它由一系列按顺序存储的元素组成；通常用于存储一组相同类型的数据，例如整数、浮点数、字符等；访问速度比较快，通过数组下标即可快速定位和访问特定元素；适用于存储列表、向量、序列等线性数据。2、二维数组二维数组是一种表格状的结构，它由一维数组组成的数组，用于存储表格数据或矩阵数据；通常用于存储二维结构的数据，例如游戏地图、图像数据、二维表格等；
距离矢量算法 —— 动态路由RIP测试
05-26
距离矢量算法是一种基于距离或成本来计算路由的算法，其中路由器将路由信息发送到相邻路由器，并根据接收到的距离信息更新路由表。动态路由协议RIP（Routing Information Protocol）就是一种距离矢量算法。 在RIP中，每个路由器都会向相邻路由器周期性发送自己的路由表，并接收相邻路由器发送的路由表。通过比较不同路由器的路由表，RIP算法可以计算出到达目标网络的最短路径，并将该路径存储在路由表中。当网络拓扑发生变化时，RIP算法会重新计算路由，以确保最短路径仍然有效。 为了测试动态路由协议RIP的功能，可以使用网络模拟器软件，如GNS3或Packet Tracer。在模拟器中，可以构建一个包含多个路由器和主机的网络拓扑，并配置每个路由器的RIP协议。然后，可以通过ping命令测试不同主机之间的连通性，并观察RIP协议如何计算最短路径并更新路由表。通过这种方式，可以测试RIP协议的可靠性和性能。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值