Swagger 适用于最小 API

Question

我正在尝试在我的项目中使用最少的 API。我面临的问题是传统控制器的方式是 swagger 为每个控制器生成一个单独的部分。但我看不到在 Minimal API 中添加这种分离的选项。是否可以使用最少的 API 在 Swagger 中添加不同的部分？

Answer 1

您可以使用WithTags扩展方法：

OpenAPI支持使用标签对象对操作进行分类。这些标签通常用于对 Swagger UI 中的操作进行分组。WithTags可以通过使用所需标签调用端点上的扩展方法来将这些标签添加到操作中。

app.MapGet("/one", () => "Hello World!").WithTags("xyz");
app.MapGet("/two", () => "Hello World!").WithTags("xyz");

它非常适合与MapGroup：

扩展MapGroup方法有助于组织具有公共前缀的端点组。RequireAuthorization它减少了重复代码，并允许通过对诸如和WithMetadata添加端点元数据之类的方法进行一次调用来自定义整个端点组。

var adminGroup = app.MapGroup("/admin")
    .WithTags("admin");
adminGroup.MapGet("/adminThing", () => "some");
adminGroup.MapPost("/doAdminThing", () => "some1");

var userGroup = app.MapGroup("/user")
    .WithTags("user");
userGroup.MapGet("/userThing", () => "some");
userGroup.MapPost("/doUserThing", () => "some1");