https://github.com/imclint21/appcore.net
AppCore.Net is a .NET library that simplifies building APIs by standardizing service management, routing, and response handling.
https://github.com/imclint21/appcore.net
api-design api-rest api-tools api-wrapper appcore asp-net-core aspnetcore backend csharp csharp-library dotnet extensions library
Last synced: 12 months ago
JSON representation
AppCore.Net is a .NET library that simplifies building APIs by standardizing service management, routing, and response handling.
- Host: GitHub
- URL: https://github.com/imclint21/appcore.net
- Owner: imclint21
- License: mit
- Created: 2024-12-06T14:15:17.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-06T14:21:48.000Z (over 1 year ago)
- Last Synced: 2024-12-06T14:30:47.661Z (over 1 year ago)
- Topics: api-design, api-rest, api-tools, api-wrapper, appcore, asp-net-core, aspnetcore, backend, csharp, csharp-library, dotnet, extensions, library
- Language: C#
- Homepage:
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ⚙️ AppCore.Net
[](https://github.com/imclint21/AppCore.Net/actions/workflows/publish.yml)
## Introduction
AppCore.Net is a library for simplifying .NET API development, offering standardized service operations, flexible routing, and seamless chaining of service results for cleaner and more maintainable code.
- **Streamlined API Controllers**: Simplifies response handling with attributes like `[ApiResponse]`, providing clear and consistent HTTP status documentation.
- **Centralized Result Management**: `ServiceResult` enables clear success or failure status, making error handling and conditional logic seamless.
- **Exception Handling Made Easy**: `ApiException` provides a straightforward way to handle specific HTTP error codes, improving code clarity.
- **Result Chaining**: Methods return `ServiceResult` or typed results, allowing for intuitive chaining and cleaner service logic.
- **Enhanced Maintainability**: Standardized patterns reduce boilerplate code, making APIs easier to build, understand, and maintain.
## Getting Started
To get started with AppCore.Net, just add the package using NuGet:
```bash
dotnet add package AppCore.Net
```
## How it Works?
Here's how to create a controller :
```csharp
public class CoffeeController(CoffeeService service) : ApiController
{
[HttpPost]
[ApiResponse(200, "Coffee prepared successfully.")]
[ApiResponse(400, "An error occurred during the preparation process.")]
public ActionResult PrepareCoffee() => service.PrepareCoffee();
}
```
And here's how to create an action in a service, each function returns a `ServiceResult`, and can be chained.
```csharp
public class CoffeeService
{
public ServiceResult DoSomething()
{
return ServiceResult.Error("Something happened!", HttpStatusCode.Conflict);
}
public ServiceResult PrepareCoffee()
{
var doSomethingResult = DoSomething();
if (doSomethingResult == false) return doSomethingResult;
return ServiceResult.Ok("The coffee is now DONE!");
}
}
```
## Contribute to AppCore
See [CONTRIBUTING.md](CONTRIBUTING.md) for best practices and instructions on setting up your development environment to work on AppCore.