Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/siberaindustries/si.endpoints
Simple ASP.NET Core API Endpoints - The alternative to Controllers and Mediator patterns.
https://github.com/siberaindustries/si.endpoints
annotations api aspnetcore communication controller controllers endpoint endpoints mvc rest swagger web
Last synced: 3 days ago
JSON representation
Simple ASP.NET Core API Endpoints - The alternative to Controllers and Mediator patterns.
- Host: GitHub
- URL: https://github.com/siberaindustries/si.endpoints
- Owner: SiberaIndustries
- License: mit
- Created: 2020-10-01T20:15:30.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-30T21:31:02.000Z (about 2 years ago)
- Last Synced: 2025-02-02T16:46:08.537Z (5 days ago)
- Topics: annotations, api, aspnetcore, communication, controller, controllers, endpoint, endpoints, mvc, rest, swagger, web
- Language: C#
- Homepage:
- Size: 73.2 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SI.Endpoints
[](https://www.nuget.org/packages/SI.Endpoints)
[](https://www.nuget.org/packages/SI.Endpoints.Swagger)
[](https://www.nuget.org/packages/SI.Endpoints.NSwag)
[](https://sonarcloud.io/dashboard?id=SiberaIndustries_SI.Endpoints)
[](https://sonarcloud.io/dashboard?id=SiberaIndustries_SI.Endpoints)
## Introduction
Have fun using this lightweight endpoint API library. No more bloated `Program.cs` files and no more bloated Controllers. This library is in between those two.
## Getting Started
### 1. Install and reference the NuGet package
```
Install-Package SI.Endpoints
```
### 2. Register the Endpoints
```cs
services.AddControllers();
services.AddEndpointsRouting();
```
### 3. Create your first Endpoint and have fun
```cs
// DTOs
public record SayHelloRequest(string Name);
public record SayHelloResponse(string Message);
// Endpoint
public class SayHello : Endpoint
{
[HttpPost]
public override ActionResult Handle(SayHelloRequest request)
{
return new SayHelloResponse("Hello " + request.Name);
}
}
```
Check out your first endpoint and navigate to: `/SayHello?Name=World!`
## Optionally Configure your endpoints
```cs
services.AddControllers();
services.AddEndpointsRouting(options =>
{
options.UseFeatures(); // Groups endpoints by the same last namespace part
options.WithPrefix("Ultra-Api"); // Adds the given prefix name to all endpoint routes
});
```
The following example shows how endpoints are configured with the given configuration:
```cs
MyApp.Endpoints.Messaging.HelloEndpoint // /Ultra-Api/Messaging/SayHello
MyApp.Endpoints.Messaging.SayGoodByeEndpoint // /Ultra-Api/Messaging/SayGoodBye
MyApp.AnotherEndpointNamespace.Calculate.Multiply // /Ultra-Api/Calculate/Multiply
MyApp.AnotherEndpointNamespace.Calculate.Subtract // /Ultra-Api/Calculate/Subtract
```
## Use the Swagger integration
If you use swagger, then you will see that every endpoint is grouped separetly. If you want to group them by feature (like a standard controller in mvc), then simply enable the feature filter.
### A. Using Swashbuckle
**1. Install the NuGet-Package**
```
Install-Package SI.Endpoints.Swagger
```
**2. Add `EnableAnnotations()` and `EnableFeatureFilter()` to the Swagger configuration**
```cs
services.AddControllers();
services.AddEndpointsRouting(options => options.UseFeatures() });
// Add swagger
services.AddSwaggerGen(options =>
{
options.EnableAnnotations(); // Make use of the Annotations
options.EnableFeatureFilter(); // Automatically group endpoints by the [feature] template
options.SwaggerDoc("v1", new OpenApiInfo { Title = "Sample endpoints", Version = "v1" });
});
```
### B. Using NSwag
**1. Install the NuGet-Package**
```
Install-Package SI.Endpoints.NSwag
```
**2. Add `EnableAnnotations()` and `EnableFeatureFilter()` to the Swagger configuration**
```cs
services.AddControllers();
services.AddEndpointsRouting(options => options.UseFeatures() });
// Add swagger
services.AddOpenApiDocument(options => options.EnableFeatureFilter()); // Option A
services.AddSwaggerDocument(options => options.EnableFeatureFilter()); // Option B
```
## Open Source License Acknowledgements and Third-Party Copyrights
- Icon made by [Freepik](https://www.flaticon.com/authors/freepik)