C# .NET最小API?

news/2024/10/31 15:22:37/

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


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

相关文章

【测试平台】Ewomail 邮件服务器搭建

一、邮件服务器背景介绍 背景介绍 使用的是开源的Ewomail邮件服务器&#xff0c;方便QA同学在进行业务测试时&#xff0c;通过测试平台自动注册邮件新账号&#xff0c; 减少手工注册的操作。前端页面调用的底层注册邮箱就是我们即将搭建的邮件服务器。 服务访问关系 前端 -&…

数学建模汇总

模型汇总 数学建模算法汇总 数据分析 数据的统计描述和分析 数据处理 用Python进行数据挖掘&#xff08;数据预处理&#xff09; Python机器学习库SKLearn&#xff1a;数据预处理 在Python中进行数据清洗和预处理缺失值处理缺失值补全 灵敏度分析 研究与分析一个系统&…

webpack5搭建react脚手架详细步骤

1. 初始化项目 首先&#xff0c;创建一个新目录并初始化项目&#xff1a; bash mkdir create-react cd create-react pnpm init --y git init 这里使用pnpm作为包管理工具&#xff0c;因为它在处理依赖和速度上表现更好。 2. 安装React和TypeScript 安装React和React-DOM…

[实战-11] FlinkSql设置时区(table.local-time-zone)

table.local-time-zone table.local-time-zone代码测试flink代码执行结果截图1. Asia/Shanghai 结果如下2. UTC结果如下 table.local-time-zone 设置flink程序运行期间得时区&#xff0c;flink的内置数据类型TIMESTAMP(3)&#xff0c; 我们设置水位线都是基于TIMESTAMP(3)类型…

seurat对象内部结构

10x Genomics格式&#xff1a; barcodes.tsv 、features/genes.tsv和matrix.mtx文件 是10X Genomics单细胞转录组测序数据的标准文件格式。这些文件通常存储在一个目录中&#xff0c;可以使用Read10X函数从R语言中读取。 barcodes.tsv&#xff1a;包含了每个单细胞的条形码信息…

【AAOS】【源码分析】CarSystemUI

目录 目录 概述 CarSystemUI组件 源代码 源码位置 主要模块 编译选项 CarSystemUI与SystemUI 编译方式 Car Emulator默认服务 CarSystemUI 启动流程 缩略词 概述 AAOS中的SystemUI虽然相较手机要简单不少,但却是车载开发中的一个重要组件,它负责管理和控制车机…

基于SpringBoot的流浪动物管理系统设计与实现

摘要 随着流浪动物数量的增加&#xff0c;如何有效管理这些动物成为社会关注的重要问题。基于Spring Boot框架的流浪动物管理系统&#xff0c;旨在通过信息化手段提高流浪动物的管理效率&#xff0c;帮助管理人员记录、追踪、安置和处理流浪动物的信息。该系统集成了用户管理、…

【无标题】idea 一次性切换多个项目的分支

适合一个目录下面有多个子项目&#xff0c;维护着共同的分支 勾选Settings-Version Control->Git->Executor branch operations on all roots 勾选前&#xff08;是不能一次切换多个项目的分支为同一个分支的&#xff09; 勾选此选项 勾选后&#xff08;可以一次切换多个…