Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DamianEdwards/MinimalApis.Extensions
A set of extensions and helpers for working with ASP.NET Core Minimal APIs.
https://github.com/DamianEdwards/MinimalApis.Extensions
Last synced: 5 days ago
JSON representation
A set of extensions and helpers for working with ASP.NET Core Minimal APIs.
- Host: GitHub
- URL: https://github.com/DamianEdwards/MinimalApis.Extensions
- Owner: DamianEdwards
- License: mit
- Created: 2021-10-08T16:07:18.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-22T22:32:55.000Z (over 1 year ago)
- Last Synced: 2024-10-30T23:06:05.272Z (12 days ago)
- Language: C#
- Size: 196 KB
- Stars: 298
- Watchers: 14
- Forks: 27
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MinimalApis.Extensions
A set of extensions and helpers that extend the functionality of ASP.NET Core Minimal APIs.
# Installation
[](https://www.nuget.org/packages/MinimalApis.Extensions/)
## NuGet Releases
This package is currently available from [nuget.org](https://www.nuget.org/packages/MinimalApis.Extensions/):
``` console
> 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](https://github.com/DamianEdwards/MinimalApis.Extensions/packages/1064549).
1. [Create a personal access token](https://github.com/settings/tokens/new) for your GitHub account with the `read:packages` scope with your desired expiration length:
[
](https://github.com/settings/tokens/new)
1. 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 `` and `` placeholders with the relevant values:
``` shell
~> dotnet nuget add source -n GitHub -u -p https://nuget.pkg.github.com/DamianEdwards/index.json
```
1. You should now be able to add a reference to the package specifying a version from the [repository packages feed](https://github.com/DamianEdwards/MinimalApis.Extensions/packages/1064549)
1. See [these instructions](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry) for further details about working with GitHub package feeds
# Getting Started
1. [Install the NuGet package](#installation) into your ASP.NET Core project:
``` shell
> dotnet add package MinimalApis.Extensions
```
1. **.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`:
``` c#
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddEndpointsMetadataProviderApiExplorer(); // <-- Add this line in .NET 6.0 projects
builder.Services.AddSwaggerGen();
...
```
1. Update your Minimal APIs to use the filters, binding, and result types from this library, e.g.:
``` c#
app.MapPut("/todos/{id}", async Task> (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`, `Body`, `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` 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](https://github.com/DamianEdwards/MinimalApis.Extensions/tree/main/samples/TodosApi.Dapper)
An example Todos application using ASP.NET Core Minimal APIs and the Dapper library for data storage in SQLite.
## [MinimalApis.Examples](https://github.com/DamianEdwards/MinimalApis.Extensions/tree/main/samples/MinimalApis.Examples)
Contains small examples for other types in this library.
## [MinimalApiPlayground](https://github.com/DamianEdwards/MinimalApiPlayground)
Shows many examples of using the types in this library along with other things related to ASP.NET Core Minimal APIs.