C#如何创建Minimal API?C#最小API开发教程

来源:菜鸟站长作者:北京GEO公司头衔:草根站长
导读:本期聚焦于小伙伴创作的《C#如何创建Minimal API?C#最小API开发教程》,敬请观看详情,探索知识的价值。以下视频、文章将为您系统阐述其核心内容与价值。如果您觉得《C#如何创建Minimal API?C#最小API开发教程》有用,将其分享出去将是对创作者最好的鼓励。

Minimal API是ASP.NET Core提供的一种轻量级API开发方式,它去除了传统MVC模式中Controller类的依赖,通过简洁的语法就能快速定义HTTP接口,非常适合构建小型服务、微服务或者快速原型项目。下面我们将一步步完成一个完整的Minimal API项目创建与开发过程。

C#如何创建Minimal API?C#最小API开发教程

环境准备

首先确保你已经安装了.NET 6及以上版本的SDK,因为Minimal API是从.NET 6开始正式引入的特性。你可以打开命令行工具,输入以下命令检查SDK版本:

dotnet --version

如果版本低于6.0,需要前往官方渠道下载安装最新版本的.NET SDK。

创建Minimal API项目

我们可以通过命令行快速创建一个Minimal API项目,执行以下命令:

dotnet new web -o MinimalApiDemo
cd MinimalApiDemo

命令执行完成后,会生成一个名为MinimalApiDemo的项目,打开项目目录下的Program.cs文件,你会看到默认的Minimal API代码结构:

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

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

app.Run();

这段代码已经定义了一个最基础的GET接口,运行项目后访问根路径就能得到Hello World的响应。

定义常用HTTP接口

Minimal API支持所有常见的HTTP方法,我们可以通过对应的Map方法快速定义接口:

  • MapGet:定义GET请求接口
  • MapPost:定义POST请求接口
  • MapPut:定义PUT请求接口
  • MapDelete:定义DELETE请求接口

下面是几个不同方法的接口示例:

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

// GET接口,返回字符串
app.MapGet("/hello", () => "Hello Minimal API");

// GET接口,带路径参数
app.MapGet("/user/{id}", (int id) => $"用户ID是:{id}");

// POST接口,接收请求体参数
app.MapPost("/user", (User user) => $"创建用户:{user.Name},年龄:{user.Age}");

// PUT接口,更新资源
app.MapPut("/user/{id}", (int id, User user) => $"更新ID为{id}的用户,新名字:{user.Name}");

// DELETE接口,删除资源
app.MapDelete("/user/{id}", (int id) => $"删除ID为{id}的用户");

app.Run();

// 定义用户实体类
public record User(string Name, int Age);

处理请求参数

Minimal API可以自动绑定多种类型的请求参数,包括路径参数、查询参数、请求体参数、请求头参数等。

路径参数

路径参数直接写在路由模板中,用花括号包裹参数名,接口方法的对应参数会自动接收该值:

app.MapGet("/product/{category}/{id}", (string category, int id) => 
{
    return $"分类:{category},商品ID:{id}";
});

查询参数

查询参数不需要在路由模板中定义,只需要在接口方法的参数中声明对应名称的参数即可自动绑定:

app.MapGet("/search", (string keyword, int page = 1) => 
{
    return $"搜索关键词:{keyword},页码:{page}";
});

访问/search?keyword=test&page=2时,keyword会接收test,page会接收2,page参数也可以不传,默认使用1。

请求体参数

对于POST、PUT等需要传递请求体的接口,只需要在参数中定义对应的实体类型,Minimal API会自动反序列化请求体的JSON数据:

app.MapPost("/login", (LoginRequest request) => 
{
    if (request.Username == "admin" && request.Password == "123456")
    {
        return new { Success = true, Message = "登录成功" };
    }
    return new { Success = false, Message = "用户名或密码错误" };
});

public record LoginRequest(string Username, string Password);

依赖注入配置

Minimal API同样支持ASP.NET Core的依赖注入机制,我们可以在构造WebApplication之前注册服务,然后在接口方法中直接使用。

首先定义一个简单的服务接口和实现:

public interface IUserService
{
    string GetUserName(int id);
}

public class UserService : IUserService
{
    public string GetUserName(int id)
    {
        // 模拟从数据库查询用户
        return $"用户{id}";
    }
}

然后在Program.cs中注册服务并使用:

var builder = WebApplication.CreateBuilder(args);
// 注册服务,生命周期为瞬时
builder.Services.AddTransient<IUserService, UserService>();

var app = builder.Build();

// 使用依赖注入,直接在参数中声明需要注入的服务
app.MapGet("/user/name/{id}", (int id, IUserService userService) => 
{
    return userService.GetUserName(id);
});

app.Run();

中间件与配置

Minimal API项目同样可以使用ASP.NET Core的中间件,比如开启Swagger文档、跨域配置等。

如果需要生成API文档,可以添加Swagger相关包并配置:

var builder = WebApplication.CreateBuilder(args);
// 添加Swagger服务
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

var app = builder.Build();

// 开发环境开启Swagger
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

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

app.Run();

运行项目后访问/swagger路径就能看到自动生成的API文档,方便接口调试和对接。

运行与测试

完成代码编写后,在项目目录下执行以下命令运行项目:

dotnet run

项目启动后会显示监听的端口,你可以使用Postman、curl或者浏览器访问对应的接口地址测试效果。比如访问https://localhost:5001/hello,就能得到Hello Minimal API的响应。

C#Minimal_APIASP.NET_CoreWeb_API修改时间:2026-07-04 22:33:13

免责声明:​ 已尽一切努力确保本网站所含信息的准确性。网站内容多为原创整理与精心编撰,观点力求客观中立。本站旨在免费分享,内容仅供个人学习、研究或参考使用。若引用了第三方作品,版权归原作者所有。如内容涉及您的权益,请联系我们处理。
内容垂直聚焦
专注技术核心技术栏目,确保每篇文章深度聚焦于实用技能。从代码技巧到架构设计,为用户提供无干扰的纯技术知识沉淀,精准满足专业提升需求。
知识结构清晰
覆盖从开发到部署的全链路。AI、前端、编程、数据库、服务器、建站、系统层层递进,构建清晰学习路径,帮助用户系统化掌握开发与运维所需的核心技术。
深度技术解析
拒绝泛泛而谈,深入技术细节与实践难点。无论是数据库优化还是服务器配置,均结合真实场景与代码示例进行剖析,致力于提供可直接应用于工作的解决方案。
专业领域覆盖
精准对应开发生命周期。从前端界面到后端编程,从数据库操作到服务器运维,形成完整闭环,一站式满足全栈工程师和运维人员的技术需求。
即学即用高效
内容强调实操性,步骤清晰、代码完整。用户可根据教程直接复现和应用于自身项目,显著缩短从学习到实践的距离,快速解决开发中的具体问题。
持续更新保障
专注既定技术方向进行长期、稳定的内容输出。确保各栏目技术文章持续更新迭代,紧跟主流技术发展趋势,为用户提供经久不衰的学习价值。