C# .NET最小API?

在.NET 5/6+中,你可以使用最小API来创建高性能的HTTP API。最小API提供了一种更轻量级的构建API的方式,它允许你直接在Program.cs文件中定义路由和处理程序,而不需要使用传统的MVC控制器。

什么是最小API?

最小API是一个用于构建HTTP API的更轻量级和模块化的框架。它允许你直接在Program.cs文件中编写端点路由,而不是使用传统的MVC控制器。这种方式更加简洁,适合于微服务和小型API项目。

创建最小API的步骤

1. 创建项目

首先,你需要创建一个新的ASP.NET Core项目。

复制代码

shell

go 复制代码
dotnet new web -o MinimalApiApp
cd MinimalApiApp

2. 修改项目文件

Program.cs文件中,你可以使用以下代码来定义你的API。

复制代码

csharp

go 复制代码
var builder = WebApplication.CreateBuilder(args);

var app = builder.Build();

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

app.Run();

3. 添加路由和处理程序

你可以定义更多的路由和处理程序来处理不同的HTTP请求。

复制代码

csharp

go 复制代码
app.MapGet("/api/todos", () => Results.Ok(new[] { "Todo 1", "Todo 2" }));
app.MapPost("/api/todos", [FromBody] Todo todo => Results.Ok(todo));

4. 使用模型

你可以定义模型来处理请求和响应。

复制代码

csharp

go 复制代码
public class Todo
{
    public int Id { get; set; }
    public string Name { get; set; }
    public bool IsComplete { get; set; }
}

5. 运行应用

运行你的应用,你将看到一个简单的HTTP API在监听请求。

复制代码

shell

go 复制代码
dotnet run

使用依赖注入

最小API也支持依赖注入,你可以在WebApplication对象上使用Services属性来注册服务。

复制代码

csharp

go 复制代码
builder.Services.AddSingleton<ITodoService, TodoService>();

然后在你的端点中使用这些服务。

复制代码

csharp

go 复制代码
app.MapGet("/api/todos", (ITodoService todoService) =>
{
    return Results.Ok(todoService.GetAll());
});

使用Swagger

为了测试你的API,你可以使用Swagger来生成一个API测试UI。

首先,添加Swagger相关的NuGet包。

复制代码

shell

go 复制代码
dotnet add package NSwag.AspNetCore

然后,在你的Program.cs文件中配置Swagger。

复制代码

csharp

go 复制代码
if (app.Environment.IsDevelopment())
{
    app.UseOpenApi();
    app.UseSwaggerUi();
}

示例代码

以下是一个完整的最小API示例,包括路由、模型和依赖注入。

复制代码

csharp

go 复制代码
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.AspNetCore.Http;
using System.Collections.Generic;
using System.Threading.Tasks;

var builder = WebApplication.CreateBuilder(args);

// Register services
builder.Services.AddSingleton<ITodoService, TodoService>();

var app = builder.Build();

// Define routes
app.MapGet("/", [HttpGet] () => "Hello World!");
app.MapGet("/api/todos", [HttpGet] (ITodoService todoService) =>
{
    return Results.Ok(todoService.GetAll());
});
app.MapPost("/api/todos", [HttpPost] ([FromBody] Todo todo, ITodoService todoService) =>
{
    todoService.Add(todo);
    return Results.Ok(todo);
});

// Run the app
app.Run();

// Model
public class Todo
{
    public int Id { get; set; }
    public string Name { get; set; }
    public bool IsComplete { get; set; }
}

// Service
public interface ITodoService
{
    IEnumerable<Todo> GetAll();
    void Add(Todo todo);
}

public class TodoService : ITodoService
{
    private List<Todo> _todos = new List<Todo>();

    public IEnumerable<Todo> GetAll()
    {
        return _todos;
    }

    public void Add(Todo todo)
    {
        _todos.Add(todo);
    }
}

结论

最小API提供了一种更简洁、更灵活的方式来构建HTTP API。它特别适合于微服务和小型项目,可以显著减少项目的复杂性和启动时间。通过上述步骤和示例代码,你可以快速开始使用最小API来构建你的.NET项目。

往期精品推荐:

在国内默默无闻的.NET,在国外火的超乎想象?

C#的膨胀之路:创新还是灭亡

介绍.NET 6款好看的winform开源UI库

介绍一款最受欢迎的.NET 开源UI库

WPF第三方开源UI框架:打造独特体验的魔法师

WPF与Winform,你的选择是?

WinForm的前世今生

.NET成年了,然后呢?------编程界的逆袭传奇

相关推荐
巨龙之路1 小时前
C语言中的assert
c语言·开发语言
2301_776681652 小时前
【用「概率思维」重新理解生活】
开发语言·人工智能·自然语言处理
码小跳2 小时前
Halcon案例(一):C#联合Halcon识别路由器上的散热孔
图像处理·c#
熊大如如2 小时前
Java 反射
java·开发语言
ll7788113 小时前
C++学习之路,从0到精通的征途:继承
开发语言·数据结构·c++·学习·算法
我不想当小卡拉米3 小时前
【Linux】操作系统入门:冯诺依曼体系结构
linux·开发语言·网络·c++
teacher伟大光荣且正确3 小时前
Qt Creator 配置 Android 编译环境
android·开发语言·qt
炎芯随笔3 小时前
【C++】【设计模式】生产者-消费者模型
开发语言·c++·设计模式
乌鸦9444 小时前
《类和对象(下)》
开发语言·c++·类和对象+
炒空心菜菜4 小时前
SparkSQL 连接 MySQL 并添加新数据:实战指南
大数据·开发语言·数据库·后端·mysql·spark