https://github.com/imclint21/initium

Initium is a .NET library that simplifies building APIs by standardizing service management, routing, and response handling.
https://github.com/imclint21/initium

api-design api-development api-rest aspnetcore csharp-extensions dotnet framework microservice middleware prometheus

Last synced: 21 days ago
JSON representation

Initium is a .NET library that simplifies building APIs by standardizing service management, routing, and response handling.

• Host: GitHub
• URL: https://github.com/imclint21/initium
• Owner: imclint21
• License: mit
• Created: 2024-12-08T14:25:20.000Z (26 days ago)
• Default Branch: master
• Last Pushed: 2024-12-08T14:29:55.000Z (26 days ago)
• Last Synced: 2024-12-08T15:18:23.956Z (26 days ago)
• Topics: api-design, api-development, api-rest, aspnetcore, csharp-extensions, dotnet, framework, microservice, middleware, prometheus
• 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

        
# Initium — Service Core Foundation

[![Publish NuGet](https://github.com/imclint21/Initium/actions/workflows/publish.yml/badge.svg?branch=master)](https://github.com/imclint21/Initium/actions/workflows/publish.yml)

![DotNet](https://img.shields.io/badge/.NET-8.0%20LTS-blue)

![MIT License](https://img.shields.io/badge/license-MIT-lightgrey.svg)

![NuGet Version](https://img.shields.io/nuget/v/Initium)

## Introduction

Initium 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 Initium, just add the package using NuGet:

```bash

dotnet add package Initium

```

## 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 Initium

See [CONTRIBUTING.md](CONTRIBUTING.md) for best practices and instructions on setting up your development environment to work on Initium.