MinimalEndpoints.Generator 1.1.0

MinimalEndpoints

A compile-time source generator for ASP.NET Core that auto-registers Minimal API endpoints — zero reflection, zero boilerplate.

一个编译时 Source Generator，为 ASP.NET Core 自动注册 Minimal API 端点 —— 无反射、无样板代码。

✨ Features / 功能特性

📦 Installation / 安装

dotnet add package MinimalEndpoints.Abstractions
dotnet add package MinimalEndpoints.Generator

Or add to your .csproj / 或直接编辑 .csproj：

<ItemGroup>
  <PackageReference Include="MinimalEndpoints.Abstractions" Version="*" />
  <PackageReference Include="MinimalEndpoints.Generator" Version="*"
                    OutputItemType="Analyzer"
                    ReferenceOutputAssembly="false" />
</ItemGroup>

🚀 Quick Start / 快速上手

1. Create an endpoint / 创建端点

using MinimalEndpoints.Abstractions;
using Microsoft.AspNetCore.Routing;

public class HelloEndpoint : ApiEndpointBase
{
    public override void Register(IEndpointRouteBuilder routes)
    {
        routes.MapGet("/hello", () => new { Message = "Hello!" });
        routes.MapGet("/hello/{name}", (string name) => new { Message = $"Hello, {name}!" });
    }
}

2. Wire up in Program.cs / 在 Program.cs 中接线

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddApiEndpoints();   // DI registration (auto-generated)

var app = builder.Build();

app.MapApiEndpoints();                // Route mapping (auto-generated)

app.Run();

That's it! All endpoints are discovered and registered at compile time.

就这样！所有端点在编译时自动发现并注册。

Method-attribute routing / 方法级特性路由

For simple endpoints, place HTTP method attributes on public static methods. ASP.NET Core still owns parameter binding ([FromBody], [AsParameters], DI services, CancellationToken, etc.).

简单端点可以直接在 public static 方法上标注 HTTP 动词特性；参数绑定仍交给 ASP.NET Core 处理。

using Microsoft.AspNetCore.Http;
using MinimalEndpoints.Abstractions;

[RoutePrefix("/api/items")]
public class ItemEndpoints
{
    [HttpGet("")]
    public static IResult List() => Results.Ok();

    [HttpGet("{id:int}")]
    public static IResult Get(int id) => Results.Ok(new { id });

    [HttpPost("")]
    public static IResult Create([Microsoft.AspNetCore.Mvc.FromBody] ItemDto dto) => Results.Created("/api/items/1", dto);
}

If a file also imports MVC attributes such as Microsoft.AspNetCore.Mvc.HttpGetAttribute, fully qualify the MinimalEndpoints HTTP attributes or use aliases to avoid ambiguous attribute names.

📖 Configuration / 配置

Per-endpoint / 端点级配置

[ApiEndpoint(
    Lifetime = EndpointLifetime.Scoped,  // DI lifecycle / DI 生命周期
    Order = 10,                          // Registration order / 注册顺序
    Skip = false                         // Skip auto-registration / 跳过自动注册
)]
public class MyEndpoint : ApiEndpointBase { ... }

Assembly-level / 程序集级配置

using MinimalEndpoints.Abstractions;

[assembly: ApiEndpointsOptions(
    GeneratedNamespace = "MyApp",                 // Output namespace / 输出命名空间
    GeneratedClassName = "EndpointExtensions",    // Output class name / 输出类名
    AddMethodName = "AddEndpoints",               // DI method name / DI 方法名
    MapMethodName = "MapEndpoints",               // Route method name / 路由方法名
    DefaultLifetime = EndpointLifetime.Scoped,    // Default lifetime / 默认生命周期
    EmitWebApplicationOverload = true,            // Generate WebApplication overload
    EmitEndpointRouteBuilderOverload = true       // Generate IEndpointRouteBuilder overload
)]

Endpoint discovery / 端点发现机制

📂 Project Structure / 项目结构

MinimalEndpoints/
├── src/
│   ├── MinimalEndpoints.Abstractions/   # Runtime types (net8.0)
│   └── MinimalEndpoints.Generator/      # Source Generator (netstandard2.0)
├── tests/
│   └── MinimalEndpoints.Tests/          # Generator unit tests
├── samples/
│   └── SampleWebApi/                    # Usage example
└── .github/workflows/ci.yml            # CI/CD pipeline

🔧 Packages / 包说明

🏗️ CI/CD

• Build & Test — triggered on every push and PR to main
• Publish to NuGet — triggered when a version tag v* is pushed (only if tests pass)

git tag v1.0.0 && git push origin v1.0.0

📄 License

MIT