Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mustaddon/singleapi
.NET Single/generic webapi endpoint for mediators
https://github.com/mustaddon/singleapi
aspnetcore cqrs cqrs-api cqrs-endpoint dotnet endpoint generic-apis generic-endpoint mediator mediator-api mediator-endpoint mediatr minimal-api rest-api single-api single-endpoint webapi webapi-extensions
Last synced: 5 days ago
JSON representation
.NET Single/generic webapi endpoint for mediators
- Host: GitHub
- URL: https://github.com/mustaddon/singleapi
- Owner: mustaddon
- License: mit
- Created: 2022-09-09T14:00:28.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-26T14:38:38.000Z (10 months ago)
- Last Synced: 2024-04-27T02:03:03.053Z (8 months ago)
- Topics: aspnetcore, cqrs, cqrs-api, cqrs-endpoint, dotnet, endpoint, generic-apis, generic-endpoint, mediator, mediator-api, mediator-endpoint, mediatr, minimal-api, rest-api, single-api, single-endpoint, webapi, webapi-extensions
- Language: C#
- Homepage:
- Size: 163 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SingleApi [](http://badge.fury.io/nu/SingleApi)
Single/generic WebApi endpoint for mediators
## Features
* Ready for mediators
* Generics support
* In/out file streams
## Example 1: SingleApi with MediatR
*.NET CLI*
```
dotnet new web --name "SingleApiExample"
cd SingleApiExample
dotnet add package SingleApi
dotnet add package MediatR
```
*Change Program.cs*
```C#
using MediatR;
using System.Reflection;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddMediatR(cfg => cfg.RegisterServicesFromAssembly(Assembly.GetExecutingAssembly()));
var app = builder.Build();
app.MapSingleApi("sapi",
// invoke the MediatR
x => x.ServiceProvider.GetRequiredService().Send(x.Data, x.CancellationToken),
// assemblies for type resolving
Assembly.GetExecutingAssembly());
app.Run();
```
[Example project...](https://github.com/mustaddon/SingleApi/tree/main/Examples/Example.MediatR)
## Example 2: Request/Response
*Request*
```
GET /sapi/Ping?data={"Message":"TEST"}
or
POST /sapi/Ping
{"Message":"TEST"}
```
*Response*
```
{"Message":"TEST PONG"}
```
## Example 3: Generics requests
```C#
app.MapSingleApi("sapi",
// for simplicity, return the received data
x => Task.FromResult(x.Data),
// existing generic types will suffice for this example
typeof(List<>).Assembly, typeof(int).Assembly);
```
*Request #1: Equivalent of List\*
```
POST /sapi/List(String)
["text1","text2","text3"]
```
*Request #2: Equivalent of Dictionary*
```
POST /sapi/Dictionary(String-Array(Nullable(Int32)))
{"key1":[555,null,777]}
```
## Example 4: .NET client
*.NET CLI*
```
dotnet new console --name "SapiClientExample"
cd SapiClientExample
dotnet add package SingleApi.Client
```
*Program.cs:*
```C#
using SingleApi.Client;
// create client
using var sapi = new SapiClient("https://localhost:7263/sapi");
// send request
var response = await sapi.Send(new Ping { Message = "TEST" });
Console.WriteLine(response?.Message);
```
*Console output:*
```
TEST PONG
```
[Example project...](https://github.com/mustaddon/SingleApi/tree/main/Examples/Example.Client)
## Example 5: File upload
*Create RequestHandler*
```C#
using MediatR;
using MetaFile;
namespace Example;
public class FileUpload : StreamFile, IRequest
{
}
public class FileUploadHandler : IRequestHandler
{
public async Task Handle(FileUpload request, CancellationToken cancellationToken)
{
var filePath = Path.GetFullPath(request.Name);
using var fileStream = File.Create(filePath);
await request.Content.CopyToAsync(fileStream, cancellationToken);
return filePath;
}
}
```
*Sending a file in JavaScript*
```js
let file = document.getElementById('my-input').files[0];
let response = await fetch('/sapi/FileUpload', {
method: 'POST',
headers: {
'content-type': file.type || 'application/octet-stream',
'content-disposition': `attachment; filename*=utf-8''${encodeURIComponent(file.name)}`,
},
body: file,
});
console.log('result:', await response.json());
```
[Example project...](https://github.com/mustaddon/SingleApi/tree/main/Examples/Example.MediatR)