621 字

3 分钟

dotnet Minimal APIs实现动态注册端点

2025-07-28

.NET 技术合集

C#

/

.NET

/

MinimalApi

dotnet Minimal APIs实现动态注册端点#

前言#

之前使用.Net的Minimal Apis框架开发了SharpIcoWeb图片转ico项目，也是初次使用这个最小Api框架，使用下来的感受就是小项目用起来非常舒服，很轻量。

在之前的项目中，我都是手动去注册端点，比如我创建了一个端点类IcoEndpoints

1
public static class IcoEndpoints
2
{
3
    public static void MapIcoEndpoints(this WebApplication app)
4
    {
5
        var group = app.MapGroup("/api");
6
        group.MapGet(...)
7
    }
8
}

然后我会在Program.cs中注册这个端点类

1
app.MapIcoEndpoints();

那么如果不想每个端点类都通过手动去注册，就可以使用动态注册的方法，动态注册的原理是通过反射和扩展方法来完成注册。

动态注册#

本文就是使用基于接口的自动注册，还可以根据约定端点类命名、特性、标记去实现注册。

文件层级结构如下：

1
SharpIcoWeb
2
├── Endpoints
3
│   ├── Internal
4
│   │   ├── EndpointExtensions.cs
5
│   │   ├── IEndpoint.cs
6
│   ├── IcoEndpoints.cs
7
│   ├── testEndpoints.cs
8
├── Program.cs

接口类#

首先目录创建完成后，去创建IEndpoint接口类，让每个端点类就去实现这个接口。

注意：static abstract接口成员需要C# 11+ (.NET 7+) 支持

1
public interface IEndpoint
2
{
3
    static abstract void MapEndpoints(IEndpointRouteBuilder app);
4
}

端点类#

测试端点类

1
public class TestEndpoints : IEndpoint
2
{
3
    public static void MapEndpoints(IEndpointRouteBuilder app)
4
    {
5
        app.MapGet("/test", async (context) =>
6
        {
7
            await context.Response.WriteAsync("Hello, World!");
8
        });
9
    }
10
}

图片转Ico端点类

1
public class IcoEndpoints: IEndpoint
2
{
3
    public static void MapEndpoints(IEndpointRouteBuilder app)
4
    {
5
        var group = app.MapGroup("/api");
6

7
        // 上传图片文件并返回文件名
8
        group.MapPost("/uploadDownload", UploadDownload)
9
            .DisableAntiforgery();
10

11
        // 获取图片信息
12
        group.MapGet("/getImageInfo/{filename}", GetImageInfo);
13

14
        // 下载文件
15
        group.MapGet("/downloads/{fileName}", DowloadFile);
16

17
        // 上传图片文件并返回文件名和不同尺寸的ICO文件的ZIP文件
18
        group.MapPost("/uploadDownload/sizes", UploadDownloadSizes)
19
            .DisableAntiforgery();
20
    }
21
}

扩展方法#

1
public static class EndpointExtensions
2
{
3
    public static void MapAllEndpoints(this IEndpointRouteBuilder app)
4
    {
5
        var endpointTypes = Assembly.GetExecutingAssembly()
6
            .GetTypes()
7
            .Where(t => typeof(IEndpoint).IsAssignableFrom(t) && !t.IsInterface && !t.IsAbstract);
8

9
        foreach (var type in endpointTypes)
10
        {
11
            type.GetMethod(nameof(IEndpoint.MapEndpoints))?
12
            .Invoke(null, new object[] { app });
13
        }
14
    }
15
}

Program.cs#

1
app.MapAllEndpoints();

完成上述配置就可以实现自动注册端点类了。

测试访问#

1
@SharpIcoWeb_HostAddress = http://localhost:5235
2

3
### 上传文件并转换为ICO（带尺寸参数）
4
POST {{SharpIcoWeb_HostAddress}}/api/uploadDownload/sizes
5
Content-Type: multipart/form-data; boundary=WebAppBoundary
6

7
--WebAppBoundary
8
Content-Disposition: form-data; name="file"; filename="1.png"
9
Content-Type: image/png
10

11
< ./1.png
12
--WebAppBoundary
13
Content-Disposition: form-data; name="sizes"
14

15
16,32,48,64,128
16

17
### 测试端点类访问
18
GET {{SharpIcoWeb_HostAddress}}/test

可以看到新建的test接口也是可以正常访问的。

总结#

实现端点类的自动注册需要使用反射和扩展方法来完成。

static abstract接口成员需要C# 11+ (.NET 7+) 支持

可以思考一下如何将服务和端点一起注册

1
builder.Services.AddScoped<IFileService, FileService>();

dotnet Minimal APIs实现动态注册端点

https://blog.pljzy.top/posts/dotnetminimalapis/dotnet-minimal-apis实现动态注册端点/

作者

ZyPlj

发布于

2025-07-28

许可协议

CC BY-NC-SA 4.0

基于Astro开发的Fuwari静态博客模版配置CICD流程

使用Cursor网页版优化SharpIcoWeb项目

1

dotnet Minimal APIs实现动态注册端点

前言

动态注册

总结