练习 – 添加控制器

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

添加控制器

在 Visual Studio Code 中选择 Controllers 文件夹,并添加名为 PizzaController.cs 的新文件。

系统会在 Controllers 目录中创建名为 PizzaController.cs 的空类文件。 目录名称 Controllers 是一种约定。 目录名称来自 Web API 使用的模型-视图-控制器体系结构。 

备注

按照惯例,控制器类名称后缀为 Controller。

将以下代码添加到 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] 属性所示。
  • 查询服务以获取所有披萨,并通过 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 参数的值。 请记住,控制器级别的 /pizza 属性定义了 [Route] 模式。
  • 查询数据库以获取与所提供的 id 参数匹配的披萨。

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

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

生成并测试控制器

运行以下命令,生成并启动 Web API:

dotnet run

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

通过运行以下命令连接到 Web API:

httprepl https://localhost:{PORT}

或者,在 HttpRepl 运行时随时运行以下命令:

(Disconnected)> connect https://localhost:{PORT}

若要查看新的可用 Pizza 终结点,请运行以下命令:

ls

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

https://localhost:{PORT}/> ls
 .                 []
 Pizza             [GET]
 WeatherForecast   [GET]

运行以下命令以转到 Pizza 终结点:

cd Pizza

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

https://localhost:{PORT}/> cd Pizza
/Pizza    [GET]

使用以下命令在 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
      }
  ]

若要查询单个披萨,可以使用以下命令发出 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
}

我们的 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"
}

在 Visual Studio Code 中,返回到下拉列表中的 dotnet 终端,并通过选择键盘上的 CTRL+C 来关闭 Web API。

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

给TA打赏
共{{data.count}}人
人已打赏
.Net Core

练习 - 添加数据存储

2022-8-12 14:57:51

.Net Core

ASP.NET Core 中的 CRUD 操作

2022-8-12 16:27:54

0 条回复 A文章作者 M管理员
    暂无讨论,说说你的看法吧
个人中心
今日签到
有新私信 私信列表
搜索