Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/immediateplatform/immediate.apis
Source Generated registrations connecting Immediate.Handlers and minimal APIs
https://github.com/immediateplatform/immediate.apis
csharp-sourcegenerator mediator mediator-pattern minimal-apis
Last synced: 24 days ago
JSON representation
Source Generated registrations connecting Immediate.Handlers and minimal APIs
- Host: GitHub
- URL: https://github.com/immediateplatform/immediate.apis
- Owner: ImmediatePlatform
- License: mit
- Created: 2024-03-19T15:27:32.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-11-13T20:56:01.000Z (29 days ago)
- Last Synced: 2024-11-13T21:39:46.602Z (29 days ago)
- Topics: csharp-sourcegenerator, mediator, mediator-pattern, minimal-apis
- Language: C#
- Homepage: https://immediateplatform.dev/
- Size: 182 KB
- Stars: 21
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: license.txt
Awesome Lists containing this project
- RSCG_Examples - https://github.com/immediateplatform/immediate.apis
README
# Immediate.Apis
[](https://www.nuget.org/packages/Immediate.Apis/)
[](https://GitHub.com/viceroypenguin/Immediate.Apis/releases/)
[](https://github.com/viceroypenguin/Immediate.Apis/blob/master/license.txt)
[](https://GitHub.com/viceroypenguin/Immediate.Apis/issues/)
[](https://GitHub.com/viceroypenguin/Immediate.Apis/issues?q=is%3Aissue+is%3Aclosed)
[](https://github.com/viceroypenguin/Immediate.Apis/actions)
---
Immediate.Apis is a source generator for minimal APIs, for
[`Immediate.Handlers`](https://github.com/viceroypenguin/Immediate.Handlers) handlers. Simply add a `[MapGet]` to the
`[Handler]` class and an endpoint will automatically be added.
#### Examples
* [Immediate.Apis.FunctionalTests](./tests/Immediate.Apis.FunctionalTests)
## Installing Immediate.Apis
You can install [Immediate.Apis with NuGet](https://www.nuget.org/packages/Immediate.Apis):
Install-Package Immediate.Apis
Or via the .NET Core command line interface:
dotnet add package Immediate.Apis
Either commands, from Package Manager Console or .NET Core CLI, will download and install Immediate.Handlers.
## Using Immediate.Apis
### Creating an Endpoint
Create a Handler and an endpoint by adding the following code:
```cs
[Handler]
[MapGet("/users")]
public static partial class GetUsersQuery
{
public record Query;
private static ValueTask> HandleAsync(
Query _,
UsersService usersService,
CancellationToken token)
{
return usersService.GetUsers();
}
}
```
### Registering the endpoints
In your `Program.cs`, add a call to `app.MapXxxEndpoints()`, where `Xxx` is the shortened form of the project name.
* For a project named `Web`, it will be `app.MapWebEndpoints()`
* For a project named `Application.Web`, it will be `app.MapApplicationWebEndpoints()`
### Customizing the endpoints
#### AsParameters
By default on POST and PUT requests Immediate.Apis will assume that your request class should be treated as a `[FromBody]`. Sometimes, however, this is not desired. For example imagine a PUT request that sits at a route `/api/todos/{id}` and updates a TODO with a given ID. We would want to get the `id` from the route and the properties to update from the body. To do so, we need to create the following request command class:
```cs
public sealed record Command
{
public sealed record CommandBody
{
// props here;
}
[FromRoute]
public required int Id { get; init; }
[FromBody]
public required CommandBody Body { get; init; }
}
```
...and modify the `HandleAsync` method to let Immediate.Apis know we want to treat the outer `Command` class as `[AsParameters]`, like so:
```cs
private static async ValueTask> HandleAsync(
[AsParameters] Command command,
ExampleDbContext dbContext,
CancellationToken ct
)
{
// ...
}
```
#### Authorization
The `[AllowAnonymous]` and `[Authorized("Policy")]` attributes are supported and will be applied to the endpoint.
```cs
[Handler]
[MapGet("/users")]
[AllowAnonymous]
public static partial class GetUsersQuery
{
public record Query;
private static ValueTask> HandleAsync(
Query _,
UsersService usersService,
CancellationToken token)
{
return usersService.GetUsers();
}
}
```
#### Additional Customization of Endpoint Registration
Additional customization of the endpoint registration can be done by adding a `CustomizeEndpoint` method.
```cs
[Handler]
[MapGet("/users")]
[Authorize(Policies.UserManagement)]
public static partial class GetUsersQuery
{
internal static void CustomizeGetFeaturesEndpoint(IEndpointConventionBuilder endpoint)
=> endpoint
.Produces>(StatusCodes.Status200OK)
.ProducesValidationProblem()
.ProducesProblem(StatusCodes.Status500InternalServerError)
.WithTags(nameof(User));
public record Query;
private static ValueTask> HandleAsync(
Query _,
UsersService usersService,
CancellationToken token)
{
return usersService.GetUsers();
}
}
```
#### Transforming the handler result into a different type
In some cases, you may wish to transform the result of the handler into a different type; for example, you may wish to return a `Results<>` type which will work with asp.net core to return various status codes.
You can transform the result of your handler into a different type by adding a `TransformResult` method, like so:
```cs
[Handler]
[MapGet("/users")]
[Authorize(Policies.UserManagement)]
public static partial class GetUsersQuery
{
internal static Results>, NotFound> TransformResult(IEnumerable result)
{
return TypedResults.Ok(result);
}
public record Query;
private static ValueTask> HandleAsync(
Query _,
UsersService usersService,
CancellationToken token
)
{
return usersService.GetUsers();
}
}
```