.NET 8 中的 Mini WebApi

news/2024/10/29 23:28:39/

介绍

    .NET 8 中的极简 API 隆重登场，重新定义了我们构建 Web 服务的方式。如果您想知道极简 API 的工作原理以及它们如何简化您的开发流程，让我们通过一些引人入胜的示例来深入了解一下。

.NET 极简主义的诞生

    想想我们曾经不得不为一个简单的 Web 服务编写几页代码。很乏味，对吧？最小 API 就像一股清新的空气。它们在 .NET 6 中引入，并在 .NET 8 中得到改进，消除了传统 ASP.NET Core MVC 模型的复杂性。不再需要控制器，不需要广泛的配置 — 这正是您所需要的。

为什么要使用最少的 API？

    1、效率：少写，多做。这是现代开发人员的口头禅。

    2、性能：它们精简、高效、快速，非常适合高性能场景。

    3、易于使用：.NET 新手？没问题！最少的 API 易于访问和掌握。

    4、灵活性：简单并不意味着受限。从微服务到大型应用程序，它们都能满足您的需求。

入门

    要开始这一旅程，请确保您已安装.NET 8 SDK。打开您最喜欢的代码编辑器，让我们创建我们的第一个最小 API。

重要设置信息：在运行本文提供的示例之前，请确保您已安装必要的 NuGet 包。对于涉及 OpenAPI 文档的功能，您将需要该Microsoft.AspNetCore.OpenApi包。您可以使用以下命令通过 NuGet 包管理器控制台安装它：

Install-Package Microsoft.AspNetCore.OpenApi

此包对于使用以下示例中显示的扩展方法至关重要WithOpenApi。

示例 1：你好，世界！

    经典入门。此 API 返回友好问候语。运行此 API，瞧！您的 API 将在http://localhost:<port>/向全世界问好。请注意，端口号可能会根据您的设置而变化。
    
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;

var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();

app.MapGet("/", () => "Hello, World!");

app.Run();
Response body:
Hello, World!
Response headers:
content-type: text/plain; charset=utf-8 
date: Tue,21 Nov 2023 13:38:37 GMT 
server: Kestrel 

设置舞台：图书服务

    在进入路由之前，让我们先了解一下设置。我们定义了一个IBookService接口及其实现BookService，它模拟了一个图书数据库。这是将数据访问逻辑封装在服务层中的经典示例，它促进了关注点分离并使代码更易于维护。

背景介绍

    “想象一下，走进一个井然有序的数字图书馆，只需点击一下鼠标即可找到每本书。这就是我们BookService在 Minimal API 设置中创建的内容。这项服务是我们应用程序的支柱，用于管理和提供图书数据。”

namespace MinimalApis
{
    public interface IBookService
    {
        List<Book> GetBooks();
        
        Book GetBook(int id);
    }

    public class BookService : IBookService
    {
        private readonly List<Book> _books;

        public BookService()
        {
            _books = new List<Book>
            {
                new()
                {
                    Id = 1,
                    Title = "Dependency Injection in .NET",
                    Author = "Mark Seemann"
                },
                new()
                {
                    Id = 2,
                    Title = "C# in Depth",
                    Author = "Jon Skeet"
                },
                new()
                {
                    Id = 3,
                    Title = "Programming Entity Framework",
                    Author = "Julia Lerman"
                },
                new()
                {
                    Id = 4,
                    Title = "Programming WCF Services",
                    Author = "Juval Lowy and Michael Montgomery"
                }
            };
        }

        public List<Book> GetBooks()
        {
            return this._books;
        }

        public Book GetBook(int id)
        {
            var book = this._books.FirstOrDefault(x => x.Id == id);

            return book;
        }
    }

    public class Book
    {
        public int Id { get; set; }

        public string Title { get; set; }

        public string Author { get; set; }
    }
}

        这IBookService是我们的蓝图，声明了我们的服务必须提供哪些功能——列出所有书籍并通过 ID 获取特定的书籍。BookService是具体的实现，我们定义这些功能如何工作。

        在里面BookService，我们有一个私有列表_books，用作我们的模拟数据库。它预先填充了一些要模拟的书籍。这种设置让我们可以专注于 API 功能，而不必担心实际的数据库连接。

        该GetBooks方法返回所有书籍，同时GetBook使用 LINQ 通过其 ID 搜索书籍。这是一种处理数据的简单而强大的方法。

builder.Services.AddSingleton<IBookService, BookService>();

        最后，我们BookService通过依赖注入系统注册，将我们的 API 集成到 Minimal API 管道中。这样，它就可以BookService在我们的应用程序中的任何地方使用。

示例 2：获取所有书籍

    本示例演示如何列出图书馆中的所有书籍。

app.MapGet("/books", (IBookService bookService) => 
    TypedResults.Ok(bookService.GetBooks()))
    .WithName("GetBooks")
    .WithOpenApi(x => new OpenApiOperation(x)
    {
        Summary = "Get Library Books",
        Description = "Returns information about all the available books from the Amy's library.",
        Tags = new List<OpenApiTag> { new() { Name = "Amy's Library" } }
    });
    
端点定义：app.MapGet("/books", ...)此行在 URL 处定义一个 GET 端点/books。

依赖注入：(IBookService bookService)这里IBookService自动注入，允许访问图书服务。

服务交互：bookService.GetBooks()调用GetBooks的方法BookService来获取所有书籍。

响应：TypedResults.Ok(...)将书籍列表包装在 HTTP 200 OK 响应中。

Swagger文档：

.WithName("GetBooks")：为清楚起见，为端点分配一个名称。
.WithOpenApi(...)：添加 Swagger UI 的描述信息，增强 API 文档。

在 Postman 或浏览器中，发送 GET 请求以https://localhost:<port>/books接收所有书籍的 JSON 列表。

[
  {
    "id": 1,
    "title": "Dependency Injection in .NET",
    "author": "Mark Seemann"
  },
  {
    "id": 2,
    "title": "C# in Depth",
    "author": "Jon Skeet"
  },
  {
    "id": 3,
    "title": "Programming Entity Framework",
    "author": "Julia Lerman"
  },
  {
    "id": 4,
    "title": "Programming WCF Services",
    "author": "Juval Lowy and Michael Montgomery"
  }
]

示例 3：通过 ID 获取特定书籍
此示例显示如何通过 ID 检索特定书籍。

app.MapGet("/books/{id}", Results<Ok<Book>, NotFound> (IBookService bookService, int id) =>
        bookService.GetBook(id) is { } book 
            ? TypedResults.Ok(book) 
            : TypedResults.NotFound()
    )
    .WithName("GetBookById")
    .WithOpenApi(x => new OpenApiOperation(x)
    {
        Summary = "Get Library Book By Id",
        Description = "Returns information about selected book from the Amy's library.",
        Tags = new List<OpenApiTag> { new() { Name = "Amy's Library" } }
    });
    
端点定义：app.MapGet("/books/{id}", ...)在 处定义一个 GET 端点/books/{id}，其中{id}是表示书籍 ID 的变量。

路线逻辑：bookService.GetBook(id) is { } book尝试通过 ID 查找书籍。如果找到，book则不为空。

条件响应：

如果找到：TypedResults.Ok(book)返回状态为 OK 的书籍。
如果未找到：TypedResults.NotFound()返回 404 未找到状态。
Swagger 文档：与示例 2 类似，为 Swagger UI 提供有意义的信息。

        要查找 ID 为 3 的图书，请向 发送 GET 请求https://localhost:<port>/books/3。您将获得 JSON 格式的图书详细信息，如果 ID 不存在，则收到 404 Not Found 响应。

{
  "id": 3,
  "title": "Programming Entity Framework",
  "author": "Julia Lerman"
}

深入了解完整代码：完整的 Program.cs

        在本节中，让我们探索一下该Program.cs文件。这是我们的 Minimal API 的所有部分汇集在一起​​的地方，从设置服务到定义端点。我将带您了解整个代码，将其分解为易于理解的部分，以便更清楚地理解。

完整代码清单

using Microsoft.AspNetCore.Http.HttpResults;
using Microsoft.OpenApi.Models;
using MinimalApis;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();
builder.Services.AddSingleton<IBookService, BookService>();

var app = builder.Build();

// configure exception middleware
app.UseStatusCodePages(async statusCodeContext
    => await Results.Problem(statusCode: statusCodeContext.HttpContext.Response.StatusCode)
        .ExecuteAsync(statusCodeContext.HttpContext));

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

app.UseHttpsRedirection();


// example 1
app.MapGet("/", () => "Hello, World!");

// example 2
app.MapGet("/books", (IBookService bookService) => 
    TypedResults.Ok(bookService.GetBooks()))
.WithName("GetBooks")
.WithOpenApi(x => new OpenApiOperation(x)
{
    Summary = "Get Library Books",
    Description = "Returns information about all the available books from the Amy's library.",
    Tags = new List<OpenApiTag> { new() { Name = "Amy's Library" } }
});

// example 3
app.MapGet("/books/{id}", Results<Ok<Book>, NotFound> (IBookService bookService, int id) =>
        bookService.GetBook(id) is { } book 
            ? TypedResults.Ok(book) 
            : TypedResults.NotFound()
    )
    .WithName("GetBookById")
    .WithOpenApi(x => new OpenApiOperation(x)
    {
        Summary = "Get Library Book By Id",
        Description = "Returns information about selected book from the Amy's library.",
        Tags = new List<OpenApiTag> { new() { Name = "Amy's Library" } }
    });

app.Run();

设置服务

    在这里，我们启动应用程序并将其注入BookService到我们的服务集合中。这可BookService在整个应用程序中使用。此外，我们还为 API 文档设置了 Swagger。

var builder = WebApplication.CreateBuilder(args); 
builder.Services.AddSingleton<IBookService, BookService>(); 
builder.Services.AddEndpointsApiExplorer(); 
builder.Services.AddSwaggerGen();

配置中间件

    本部分主要介绍中间件配置。UseStatusCodePages有助于处理 HTTP 状态代码，同时UseHttpsRedirection确保安全连接。在开发环境中启用 Swagger UI，以便于测试和探索。

var app = builder.Build();
app.UseStatusCodePages(...);
app.UseHttpsRedirection();
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

定义端点

    这里，我们定义了三个端点：一个简单的问候语，一个列出所有书籍的端点，以及另一个通过 ID 获取特定书籍的端点。这些端点使用我们的BookService与书籍数据进行交互。

app.MapGet("/", () => "Hello, World!");
app.MapGet("/books", ...);
app.MapGet("/books/{id}", ...);

运行应用程序

        最后，此行启动我们的应用程序，使其监听传入的请求。

app.Run();

        该Program.cs文件就像管弦乐队的指挥，确保我们的 Minimal API 的每个部分都能和谐地演奏。它证明了 .NET 8 中 Minimal API 的强大功能 - 简单而强大，使我们能够轻松构建高效且有效的 Web 服务。

退出时

    这些代码片段有效地演示了如何使用 .NET 中的 Minimal API 来创建干净、可维护且文档齐全的 Web 服务。通过利用依赖注入和清晰的路由，我们创建了一个易于理解和使用的 API。无论是列出所有书籍还是查找特定书籍，API 都能优雅高效地处理这些任务。


http://www.ppmy.cn/news/1542934.html

相关文章

OpenCV通道拆分：深入理解图像处理

OpenCV通道拆分：深入理解图像处理

在图像处理中&#xff0c;通道拆分是一项基本而重要的操作。它允许我们分别处理图像的每个颜色通道&#xff0c;从而实现更精细的图像分析和处理。OpenCV&#xff0c;作为一个强大的计算机视觉库&#xff0c;提供了多种方法来实现通道拆分。在本文中&#xff0c;我们将通过一个…
阅读更多...
【JavaEE】【多线程】定时器

【JavaEE】【多线程】定时器

目录 一、定时器简介1.1 Timer类1.2 使用案例 二、实现简易定时器2.1 MyTimerTask类2.2 实现schedule方法2.3 构造方法2.4 总代码2.5 测试 一、定时器简介 定时器&#xff1a;就相当于一个闹钟&#xff0c;当我们定的时间到了&#xff0c;那么就执行一些逻辑。 1.1 Timer类 …
阅读更多...
912.排序数组（桶排序）

912.排序数组（桶排序）

目录 题目解法 题目 给你一个整数数组 nums&#xff0c;请你将该数组升序排列。 你必须在 不使用任何内置函数 的情况下解决问题&#xff0c;时间复杂度为 O(nlog(n))&#xff0c;并且空间复杂度尽可能小。 解法 class Solution { public:vector<int> sortArray(vect…
阅读更多...
Java应用程序的测试覆盖率之设计与实现（四）-- jacoco-maven-plugin

Java应用程序的测试覆盖率之设计与实现（四）-- jacoco-maven-plugin

说在前面的话 加载jacocoagent，开始采集覆盖率数据。 java -javaagent:doc/jacocoagent.jar=includes=com.jacoco.*,output=tcpserver,port=7195,address=172.27.3.242,classdumpdir=classdumpdir/classes/ \ -jar target/jacoco-test-sample.jar. ____ _ …
阅读更多...
ELK同时采集Nginx、linux内核日志信息

ELK同时采集Nginx、linux内核日志信息

在logstash服务机器136上安装nginx(配置ELK服务在上一篇文档中&#xff09; 复制之前写的linux内核日志采集配置文档改名字为linux_nginx.conf 编辑linux_nginx.conf 修改完成后启动nginx服务 重新加载linux_nginx.conf配置文件 看到有java进程说明logstash采集成功&#xff0c…
阅读更多...
无人机遗传算法详解！

无人机遗传算法详解！

一、遗传算法概述 遗传算法是一种模拟自然选择和遗传机制的优化算法&#xff0c;它仿效生物的进化与遗传&#xff0c;根据生存竞争和优胜劣汰的法则&#xff0c;通过遗传操作&#xff08;选择、交叉、变异&#xff09;&#xff0c;使所求问题的解逐步逼近最优解。 二、无人机…
阅读更多...
MemoRAG：重新定义长期记忆的AI问答模型

MemoRAG：重新定义长期记忆的AI问答模型

MemoRAG模型是如何实现长记忆的&#xff1f; ©作者|Blaze 来源|神州问学 引言 随着人工智能的发展&#xff0c;AI问答模型在各种应用场景中表现出色&#xff0c;尤其是在信息检索和知识问答领域。传统的RAG模型通过结合外部知识库的实时检索与生成模型&#xff0c;极大地…
阅读更多...
『完整代码』宠物召唤

『完整代码』宠物召唤

创建脚本并编写&#xff1a;PetFollowTarget.cs using UnityEngine; public class PetFollowTarget : MonoBehaviour{Transform target;float speed 2f;Animator animator;void Start(){target GameObject.Find("PlayerNormal/PetsSmallPos").gameObject.transform…
阅读更多...
最新文章

Copyright @ 2022~2023