自学内容网 自学内容网
自学内容网 > 正文

添加控制器

🕗 发布于 2024-11-30 04:25 .net  

控制器是一个公共类，具有一个或多个称为“操作”的公共方法。 按照惯例，控制器放在项目根目录的 Controllers 目录中。 这些操作在 Web API 控制器内公开为 HTTP 终结点。

文章目录

在这里插入图片描述
在这里插入图片描述

一、添加控制器

  1. 在 Visual Studio Code 中选择 Controllers 文件夹，并添加名为 PizzaController.cs 的新文件。
    在这里插入图片描述
    系统会在 Controllers 目录中创建名为 PizzaController.cs 的空类文件。 目录名称“Controllers”是一种约定。 目录名称来自 Web API 使用的模型-视图-控制器体系结构。

备注
按照惯例，控制器类名称后缀为 Controller。

  1. 将以下代码添加到 Controllers/PizzaController.cs。 保存所做更改。
using ContosoPizza.Models;
using ContosoPizza.Services;
using Microsoft.AspNetCore.Mvc;

namespace ContosoPizza.Controllers;

[ApiController]
[Route("[controller]")]
public class PizzaController : ControllerBase
{
    public PizzaController()
    {
    }

    // GET all action

    // GET by Id action

    // POST action

    // PUT action

    // DELETE action
}

如前文所述，此类派生自 ControllerBase，后者是 ASP.NET Core 中用于处理 HTTP 请求的基类。 它还包含你已经了解的两个标准属性：即 [ApiController] 和 [Route]。 如前文所述，[Route] 属性定义了到 [controller] 令牌的映射。 由于此控制器类名为 PizzaController，因此该控制器处理对 https://localhost:{PORT}/pizza 的请求。

二、获取所有披萨

需要实现的第一个 REST 谓词是 GET，使用该谓词，客户端可以从 API 获取所有披萨。 可使用内置 [HttpGet] 属性来定义从服务返回披萨的方法。

将 Controllers/PizzaController.cs 中的 // GET all action 注释替换为以下代码：

[HttpGet]
public ActionResult<List<Pizza>> GetAll() =>
    PizzaService.GetAll();

上一个操作：

  • 仅响应 HTTP GET 谓词，如 [HttpGet] 属性所示。
  • 返回类型为 List 的 ActionResult 实例。 ActionResult 类型是 ASP.NET Core 中所有操作结果的基类。
  • 查询服务以获取所有披萨，并通过 Content-Type 的值 application/json 自动返回数据。

三、检索单种披萨

客户端可能还需要请求获取特定披萨而非整个列表的相关信息。 你可以实现另一个 GET 操作，此操作需要 id 参数。 可使用内置 [HttpGet(“{id}”)] 属性来定义从服务返回披萨的方法。 路由逻辑将 [HttpGet]（没有 id）和 [HttpGet(“{id}”)]（具有 id）注册为两个不同的路由。 然后，你可以编写一个单独的操作来检索单个项。

将 Controllers/PizzaController.cs 中的 // GET by Id action 注释替换为以下代码：

[HttpGet("{id}")]
public ActionResult<Pizza> Get(int id)
{
    var pizza = PizzaService.Get(id);

    if(pizza == null)
        return NotFound();

    return pizza;
}

上一个操作：

  • 仅响应 HTTP GET 谓词，如 [HttpGet] 属性所示。
  • 要求 pizza/ 之后的 URL 段中包含 id 参数的值。 请记住，控制器级别的 [Route]属性定义了/pizza模式。
  • 查询数据库以获取与所提供的 id 参数匹配的披萨。

上述操作中使用的每个 ActionResult 实例都映射到下表中对应的 HTTP 状态代码：

ASP.NET Core 操作结果HTTP 状态代码说明
Ok 为隐式200内存中缓存中存在与所提供的 id 参数匹配的产品。该产品包含在由 accept HTTP 请求标头中所定义的媒体类型（默认情况下为 JSON）的响应正文中。
NotFound404内存中缓存中不存在与所提供的 id 参数匹配的产品。

四、生成并运行新控制器

运行以下命令，生成并启动 Web API：

dotnet run

五、使用 Http 文件测试控制器

  1. 打开 ContosoPizza.http

  2. 添加新的 GET 以在 ### 分隔符下调用 Pizza 终结点：

GET {{ContosoPizza_HostAddress}}/pizza/
Accept: application/json

###
  1. 选择此新 GET 调用上方的“发送请求”命令。

前面的命令将以 JSON 格式返回所有披萨列表：

HTTP/1.1 200 OK
Connection: close
Content-Type: application/json; charset=utf-8
Date: Wed, 17 Jan 2024 16:57:09 GMT
Server: Kestrel
Transfer-Encoding: chunked

[
    {
        "id": 1,
        "name": "Classic Italian",
        "isGlutenFree": false
    },
    {
        "id": 2,
        "name": "Veggie",
        "isGlutenFree": true
    }
]
  1. 若要查询单个披萨，可以使用以下命令发出 GET 请求，但传入 id 参数：
GET {{ContosoPizza_HostAddress}}/pizza/1
Accept: application/json

###

前面的命令返回 Classic Italian，输出结果如下：

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Fri, 02 Apr 2021 21:57:57 GMT
Server: Kestrel
Transfer-Encoding: chunked

{
    "id": 1,
    "name": "Classic Italian",
    "isGlutenFree": false
}
  1. 我们的 API 还可以处理项不存在的情况。 使用以下命令再次调用该 API，但传入一个无效的披萨 id 参数：
GET {{ContosoPizza_HostAddress}}/pizza/5
Accept: application/json

###

前面的命令返回 404 Not Found 错误，输出结果如下：

HTTP/1.1 404 Not Found
Content-Type: application/problem+json; charset=utf-8
Date: Fri, 02 Apr 2021 22:03:06 GMT
Server: Kestrel
Transfer-Encoding: chunked

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
    "title": "Not Found",
    "status": 404,
    "traceId": "00-ec263e401ec554b6a2f3e216a1d1fac5-4b40b8023d56762c-00"
}

现在，你已完成实现 GET 谓词。 在下一个单元中，你可以向 PizzaController 添加更多操作以支持对披萨数据执行 CRUD 操作。

六、可选：使用命令行 HTTP 读取-求值-打印循环 (REPL) 测试控制器

  1. 打开现有 httprepl 终端，或者通过从主菜单中选择“终端”>“新终端”，从 Visual Studio Code 中打开新的集成终端。

  2. 通过运行以下命令连接到 Web API：

httprepl https://localhost:{PORT}

或者，在 HttpRepl 运行时随时运行以下命令：

connect https://localhost:{PORT}
  1. 若要查看新的可用 Pizza 终结点，请运行以下命令：
ls

前面的命令将检测连接的终结点上所有可用的 API。 此命令应显示以下代码：

https://localhost:{PORT}/> ls
 .                 []
 Pizza             [GET]
 WeatherForecast   [GET]
  1. 运行以下命令以转到 Pizza 终结点：
cd Pizza

前面的命令将显示 Pizza 终结点的可用 API 的输出：

https://localhost:{PORT}/> cd Pizza
/Pizza    [GET]
  1. 使用以下命令在 HttpRepl 中发出 GET 请求：
get

前面的命令将以 JSON 格式返回所有披萨列表：

HTTP/1.1 200 OK
  Content-Type: application/json; charset=utf-8
  Date: Fri, 02 Apr 2021 21:55:53 GMT
  Server: Kestrel
  Transfer-Encoding: chunked

  [
      {
          "id": 1,
          "name": "Classic Italian",
          "isGlutenFree": false
      },
      {
          "id": 2,
          "name": "Veggie",
          "isGlutenFree": true
      }
  ]
  1. 若要查询单个披萨，可以使用以下命令发出 GET 请求，但传入 id 参数：
get 1

前面的命令返回 Classic Italian，输出结果如下：

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Fri, 02 Apr 2021 21:57:57 GMT
Server: Kestrel
Transfer-Encoding: chunked

{
    "id": 1,
    "name": "Classic Italian",
    "isGlutenFree": false
}
  1. 我们的 API 还可以处理项不存在的情况。 使用以下命令再次调用该 API，但传入一个无效的披萨 id 参数：
get 5

前面的命令返回 404 Not Found 错误，输出结果如下：

HTTP/1.1 404 Not Found
Content-Type: application/problem+json; charset=utf-8
Date: Fri, 02 Apr 2021 22:03:06 GMT
Server: Kestrel
Transfer-Encoding: chunked

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
    "title": "Not Found",
    "status": 404,
    "traceId": "00-ec263e401ec554b6a2f3e216a1d1fac5-4b40b8023d56762c-00"
}
  1. 在 Visual Studio Code 中，返回到下拉列表中的 dotnet 终端，并通过选择键盘上的 CTRL+C 来关闭 Web API。

现在，你已完成实现 GET 谓词。 在下一个单元中，你可以向 PizzaController 添加更多操作以支持对披萨数据执行 CRUD 操作。

在这里插入图片描述


原文地址：https://blog.csdn.net/hidescold/article/details/144106112

免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！

相关文章

  • Java面向对象.抽象

    抽象类是一种不能被实例化的类，它主要用于被其他类继承。在Java中，使用 abstract 关键字来定义抽象类。// 抽象类的成员变量、方法等- 抽象类通常包含抽象方法和非抽象方法以及成员变量。1.抽

    阅读更多2024-11-30
  • Linux笔记---进程：程序地址空间

    Linux虚拟地址空间是操作系统为每个进程提供的一组虚拟地址，这些地址在进程看来是连续的，但实际上它们会被映射到物理内存的不同位置。虚拟地址空间的目的是使每个进程都认为自己独占了整个内存，从而简化内存

    阅读更多2024-11-30
  • 电销卡风险管理系统

    磐石云炫客有道管理系统功能模块设计1. 用户话单采集模块功能：从用户手机获取本地话单数据（通话记录、短信记录）。数据字段：通话类型（主叫/被叫）对方号码通话时间通话时长技术实现

    阅读更多2024-11-30
  • Ubuntu20.04安装NVIDIA显卡驱动

    会显示recommended的下载（但是这里推荐的535版本的driver并不是真正匹配当前显卡的，只是ubuntu官方维护到的最新版本，下载后会导致ubuntu无法进入图形界面）Nouveau是一个

    阅读更多2024-11-30
  • PDF版地形图矢量出现的问题

    类似的情况再实际的工作中你会经常的遇到，自动地形图实现了电子化，原始的比例尺的概念也就成鸡肋了，过去没有完全电子化的年代，比例尺是有很大的用处的，你通过量取地形图上的距离根据比例尺就可以推断出实地的距

    阅读更多2024-11-30
  • 『python爬虫』使用docling 将pdf或html网页转为MD （保姆级图文）

    大家喜欢的话，给个👍，点个关注！给大家分享更多计算机专业学生的求学之路！发现你走远了@mzh原创作品，转载必须标注原文链接欢迎关注『python爬虫』 专栏，持续更新中欢迎关注『python爬虫』 专

    阅读更多2024-11-30
  • Ps：存储 Adobe PDF - 安全性

    在 Adobe Photoshop 中，将图像保存为 PDF 文件时， “存储为 Adobe PDF” 对话框，提供各种选项以自定义 PDF 文件的输出方式。“安全性” Security选项卡为 PD

    阅读更多2024-11-30
  • uni-app获取到的数据如何保留两位小数

    {{ (chartD.selfPowerCount || 0).toFixed(2) }}

    阅读更多2024-11-30
  • 常见的分布式解决方案的横向对比

    在进行分布式架构技术选型时，不同的方案有不同的优势和局限。性能需求：如果对性能要求极高（尤其是高并发、高吞吐量），Kafka、Redis、Dubbo等可能是更好的选择。技术栈兼容：如果已经使用了Spr

    阅读更多2024-11-30
  • 分布式储能监控系统为储能电站高效运维与精细化管理赋能

    分布式储能系统能够在电网负荷高峰期放电，低谷期充电，实现电力的“削峰填谷”，有效缓解电网调峰压力，提升能源利用效率。分布式储能监控系统通过智能调度和管理，能够精准捕捉电网负荷变化，实现电力的合理分配与

    阅读更多2024-11-30
自学内容网
Copyright © 2015-2024