MinimalApis.Extensions 0.11.0

MinimalApis.Extensions

一组扩展和助手，可扩展 ASP.NET Core 最小 API 的功能。

安装

NuGet 发布

此包目前在 nuget.org 上可用

> dotnet add package MinimalApis.Extensions

CI 构建

如果您希望使用此存储库的 main 分支的构建，您可以从 此存储库的包源 安装它们。

1. 为您的 GitHub 帐户创建一个具有 read:packages 范围的 个人访问令牌，并设置所需的有效期长度

   <img width="583" alt="image" src="https://user-images.githubusercontent.com/249088/160220117-7e79822e-a18a-445c-89ff-b3d9ca84892f.png">

2. 在命令行中，导航到您的用户配置文件目录，然后运行以下命令将包源添加到您的 NuGet 配置中，将 <GITHUB_USER_NAME> 和 <PERSONAL_ACCESS_TOKEN> 占位符替换为相关值

   ~> dotnet nuget add source -n GitHub -u <GITHUB_USER_NAME> -p <PERSONAL_ACCESS_TOKEN> https://nuget.pkg.github.com/DamianEdwards/index.json
   

3. 现在您应该能够添加一个指定版本的包引用来 存储库包源

4. 有关使用 GitHub 包源的其他详细信息，请参阅 这些说明

入门

1. 将 NuGet 包安装到您的 ASP.NET Core 项目

   > dotnet add package MinimalApis.Extensions
   

2. 仅适用于.NET 6.0项目 在您的项目中的 Program.cs 文件中，调用 builder.Services 上的 AddEndpointsMetadataProviderApiExplorer() 方法以在 ApiExplorer 中启用增强的端点元数据

   var builder = WebApplication.CreateBuilder(args);
   builder.Services.AddEndpointsMetadataProviderApiExplorer(); // <-- Add this line in .NET 6.0 projects
   builder.Services.AddSwaggerGen();
   ...
   

3. 更新您的Minimal APIs以使用此库中的过滤器、绑定和结果类型，例如：

   app.MapPut("/todos/{id}", async Task<Results<NotFound, NoContent>> (int id, Todo todo, TodoDb db) =>
   {
       var existingTodo = await db.Todos.FindAsync(id);
   
       if (existingTodo is null)
           return TypedResults.NotFound();
   
       existingTodo.Title = todo.Title;
       existingTodo.IsCompleted = todo.IsCompleted;
   
       await db.SaveChangesAsync();
   
       return TypedResults.NoContent();
   })
   .WithParameterValidation();
   

包含内容：

此库提供了帮助扩展ASP.NET Core Minimal APIs核心功能的类型，方式如下：

• 通过 IParameterBinder 和 Bind<TValue>、Body<TValue>、JsonFormFile 等提供增强的参数绑定
• 通过 Results.Extensions 提供PlainText、Html 和 UnsupportedMediaType 等额外的结果类型
• 对于.NET 7.0应用程序，提供一个端点过滤器，用于验证路由处理程序参数，并在验证失败时自动响应验证问题
• 包括用于.NET 6.0项目的.NET 7.0特性填充
  • 提供易于进行单元测试的泛型 IResult 对象（通过 TypedResults 提供），包括 IStatusCodeHttpResult、IContentTypeHttpResult 和 IValueHttpResult 接口
  • 通过输入和结果类型通过 IEndpointParameterMetadataProvider 和 IEndpointMetadataProvider 填充端点元数据，自动在 Swagger/OpenAPI 中填充详细的端点描述
  • 通过 Results<TResult1, TResultN> 联合 IResult 返回类型，允许路由处理程序委托声明它们可以返回的所有可能的 IResult 类型，启用编译时类型检查，并自动从类型信息中填充所有可能的响应到 Swagger/OpenAPI 中

示例项目

TodoApis.Dapper

一个使用 ASP.NET Core Minimal APIs 和 Dapper 库存 SQLite 中进行数据存储的待办事项应用的示例。

MinimalApis.Examples

包含此库中其他类型的简单示例。

MinimalApiPlayground

展示了许多使用此库中的类型以及与 ASP.NET Core Minimal APIs 相关的其他事物的示例。