Skip to content

Latest commit

 

History

History
76 lines (61 loc) · 4.77 KB

README.md

File metadata and controls

76 lines (61 loc) · 4.77 KB
Raw

MinimalApis.Extensions

A set of extensions and helpers that extend the functionality of ASP.NET Core Minimal APIs.

Installation

Nuget

NuGet Releases

This package is currently available from nuget.org:

> dotnet add package MinimalApis.Extensions

CI Builds

If you wish to use builds from this repo's main branch you can install them from this repo's package feed.

  1. Create a personal access token for your GitHub account with the read:packages scope with your desired expiration length:

    image

  2. At the command line, navigate to your user profile directory and run the following command to add the package feed to your NuGet configuration, replacing the <GITHUB_USER_NAME> and <PERSONAL_ACCESS_TOKEN> placeholders with the relevant values:

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

  3. You should now be able to add a reference to the package specifying a version from the repository packages feed

  4. See these instructions for further details about working with GitHub package feeds

Getting Started

  1. Install the NuGet package into your ASP.NET Core project: 
    > dotnet add package MinimalApis.Extensions
  2. .NET 6.0 projects only In your project's Program.cs, call the AddEndpointsMetadataProviderApiExplorer() method on builder.Services to enable enhanced endpoint metadata in ApiExplorer: 
    var builder = WebApplication.CreateBuilder(args);
builder.Services.AddEndpointsMetadataProviderApiExplorer(); // <-- Add this line in .NET 6.0 projects
builder.Services.AddSwaggerGen();
...
  3. Update your Minimal APIs to use the filters, binding, and result types from this library, e.g.: 
    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();

What's Included?

This library provides types that help extend the core functionality of ASP.NET Core Minimal APIs in the following ways:

  • Enhanced parameter binding via IParameterBinder and Bind<TValue>, Body<TValue>, JsonFormFile, and others
  • Extra result types available via Results.Extensions including PlainText, Html, and UnsupportedMediaType
  • For .NET 7.0 apps, an endpoint filter that validates route handler parameters and auto-responds with validation problem if validation fails
  • Poly-filling of .NET 7.0 features for use in .NET 6.0 projects including:
    • Typed IResult objects for easier unit testing (available via TypedResults) including the IStatusCodeHttpResult, IContentTypeHttpResult, and IValueHttpResult interfaces
    • Automatic population of detailed endpoint descriptions in Swagger/OpenAPI via the ability for input and result types to populate endpoint metadata via IEndpointParameterMetadataProvider and IEndpointMetadataProvider
    • Union IResult return types via Results<TResult1, TResultN> that enable route handler delegates to declare all the possible IResult types they can return, enabling compile-time type checking and automatic population of all possible responses in Swagger/OpenAPI from type information

Sample Projects

TodoApis.Dapper

An example Todos application using ASP.NET Core Minimal APIs and the Dapper library for data storage in SQLite.

MinimalApis.Examples

Contains small examples for other types in this library.

MinimalApiPlayground

Shows many examples of using the types in this library along with other things related to ASP.NET Core Minimal APIs.