jff-csharp-tools 5.4.0

jff-csharp-tools

jff-csharp-tools is an open-source NuGet library suite for .NET Core (versions 6, 8 and 9) that provides reusable utilities to accelerate C# API development. It ships opinionated base classes and helpers for the most common boilerplate patterns: base entities with audit fields, generic repository/service layers, ready-made CRUD controllers and Minimal API endpoints, global exception handling, JWT authentication helpers, and a rich set of domain extensions.

📖 Documentation: /docs

Install Package Manager

PM> Install-Package jff_csharp-tools-6

or

PM> Install-Package jff_csharp-tools-8

or

PM> Install-Package jff_csharp-tools-9

Install .NET CLI

> dotnet add package jff_csharp-tools-6

or

> dotnet add package jff_csharp-tools-8

or

> dotnet add package jff_csharp-tools-9

Install Paket CLI

> paket add jff_csharp-tools-6

or

> paket add jff_csharp-tools-8

or

> paket add jff_csharp-tools-9

Example of use in a .NET API project

Example 1: Using default entities

using Jff.CSharpTools.Domain.Entity;

public class MyEntity : DefaultEntity
{
    public string Name { get; set; }
}

Namespaces may vary depending on the package version (6, 8, or 9). Adjust the namespace according to the package installed in your project.

Example 2: Using DefaultService

using JffCsharpTools8.Domain.Service;
using JffCsharpTools8.Domain.Repository;
using JffCsharpTools.Domain.Entity;
using JffCsharpTools.Domain.Filters;
using JffCsharpTools.Domain.Model;
using Microsoft.EntityFrameworkCore;

// Suppose you have an entity:
public class Product : DefaultEntity<Product>
{
    public string Name { get; set; }
}

// And a DbContext:
public class MyDbContext : DbContext
{
    public DbSet<Product> Products { get; set; }
}

// Instantiating the service (dependency injection recommended):
var repository = new DefaultRepository<MyDbContext>(/* parameters */);
var service = new DefaultService<MyDbContext>(repository);

// Creating a new product
var newProduct = new Product { Name = "T-shirt" };
var createResult = await service.Create<Product>(userId, newProduct);

// Getting all products
var products = await service.Get<Product>();

// Getting products by user
var userProducts = await service.GetByUser<Product>(userId);

// Getting products by filter
var filter = new DefaultFilter<Product> { /* set filters */ };
var filteredProducts = await service.GetByFilter<Product, DefaultFilter<Product>>(filter);

// Getting product by primary key
var product = await service.GetByKey<Product, int>(userId, productId);

// Paginating products
var pagination = new PaginationModel<Product>
{
    Page = 1,
    PageSize = 10,
    Filter = new DefaultFilter<Product>()
};
var paginatedProducts = await service.GetPaginated<Product>(pagination, x => x.Name != null);

// Updating a product
newProduct.Name = "Updated T-shirt";
var updateResult = await service.UpdateByKey<Product, int>(userId, newProduct, productId);

// Deleting a product
var deleteResult = await service.DeleteByKey<Product, int>(userId, productId);

Adapt the examples according to the package version (6, 8 or 9) and the namespaces used in your project.

Technology Stack

Principal Modules

How to Build Locally

Prerequisites

• .NET SDK 9 (also supports .NET 6 and 8)
• Git

Clone and restore

git clone https://github.com/josembergff/jff-csharp-tools.git
cd jff-csharp-tools
dotnet restore

Build all projects

dotnet build jff-csharp-tools.sln

Build a specific package

dotnet build jff-csharp-tools-9/jff-csharp-tools-9.csproj

Pack NuGet packages

dotnet pack jff-csharp-tools-9/jff-csharp-tools-9.csproj --configuration Release

Or use the provided release script:

bash run-releaseBuild.sh

Documentation

Full technical documentation is located in /docs: