slothful-crud 1.0.0-rc.3

This is a prerelease version of slothful-crud.
dotnet add package slothful-crud --version 1.0.0-rc.3
NuGet\Install-Package slothful-crud -Version 1.0.0-rc.3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="slothful-crud" Version="1.0.0-rc.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add slothful-crud --version 1.0.0-rc.3
#r "nuget: slothful-crud, 1.0.0-rc.3"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install slothful-crud as a Cake Addin
#addin nuget:?package=slothful-crud&version=1.0.0-rc.3&prerelease

// Install slothful-crud as a Cake Tool
#tool nuget:?package=slothful-crud&version=1.0.0-rc.3&prerelease

<div align="center"> <img src="docs/assets/slothful-api.jpg" alt="slothful-api logo"> </div>

Slothful CRUD

Slothful CRUD is a library designed to streamline the creation of CRUD endpoints effortlessly. By implementing the necessary interfaces in domain classes, you can quickly register the library and generate RESTful endpoints. Simplify your API development with Slothful CRUD.

Documentation

Get started by reading through the documentation.

Getting Started

Follow these steps to integrate Slothful CRUD into your project:

  1. Configure Your Domain Classes:

Create domain classes representing your data entities. Implement the appropriate interfaces for CRUD operations.

  1. Register the Library:

Integrate Slothful API by registering it in your application.

  1. Run Your Application:

Start your application to automatically generate RESTful endpoints based on your domain classes.

Configuration

The base configuration class that defines shared settings for all other configuration classes:

  • ExposeAllNestedProperties (bool): Set to true to expose all nested properties via the API. Useful for debugging or gaining granular control over nested data.
  • IsAuthorizationEnable (bool): Determines whether authorization checks are enabled. If set to true, the policies listed in PolicyNames are applied.
  • PolicyNames (string[]): An array of policy names to apply for authorization.

EndpointConfiguration (inherits Configuration)

Defines properties specific to API endpoints:

  • IsEnable (bool): Determines if the endpoint is enabled.

EntityConfiguration (inherits Configuration)

Provides settings specific to entity management:

  • SortProperty (string): Specifies the property name used to sort entities.
  • FilterProperty (string): Identifies the property name used to filter entities.
  • KeyProperty (string): Defines the primary key property name for identifying entities.
  • KeyPropertyType (Type): Indicates the type of the primary key property (e.g., int, string).
  • UpdateMethod (string): Specifies the method used to update entities.
  • HasValidation (bool): Enables or disables validation for entities to ensure compliance with business rules.
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0-rc.3 42 6/8/2024
1.0.0-rc.2 33 6/8/2024
1.0.0-rc.1 54 5/24/2024