C# .NET最小API?

科技   2024-10-26 12:30   安徽  

在.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

dotnet new web -o MinimalApiApp
cd MinimalApiApp

2. 修改项目文件

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

csharp

var builder = WebApplication.CreateBuilder(args);

var app = builder.Build();

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

app
.Run();

3. 添加路由和处理程序

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

csharp

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

4. 使用模型

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

csharp

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

5. 运行应用

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

shell

dotnet run

使用依赖注入

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

csharp

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

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

csharp

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

使用Swagger

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

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

shell

dotnet add package NSwag.AspNetCore

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

csharp

if (app.Environment.IsDevelopment())
{
app
.UseOpenApi();
app
.UseSwaggerUi();
}

示例代码

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

csharp

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成年了,然后呢?——编程界的逆袭传奇


CSharp编程大全
C#编程.net core开发,winform桌面开发,wpf开发,c sharp编程大全,CSharp程序开发,C#开发实例(附源代码),编程过程遇到的各种坑详解!
 最新文章