Arks.Framework.Endpoints.Web 2.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Arks.Framework.Endpoints.Web --version 2.0.0
                    


                    

                
NuGet\Install-Package Arks.Framework.Endpoints.Web -Version 2.0.0
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="Arks.Framework.Endpoints.Web" Version="2.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Arks.Framework.Endpoints.Web" Version="2.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Arks.Framework.Endpoints.Web" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Arks.Framework.Endpoints.Web --version 2.0.0
                    


                    

                
#r "nuget: Arks.Framework.Endpoints.Web, 2.0.0"
#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. 
#:package Arks.Framework.Endpoints.Web@2.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Arks.Framework.Endpoints.Web&version=2.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Arks.Framework.Endpoints.Web&version=2.0.0
                    


                            Install as a Cake Tool

ArkaSoftware.Framework.Endpoints.Web

ArkaSoftware.Framework.Endpoints.Web is a library designed to enhance web endpoint development in .NET applications. It includes base controllers, middleware, filters, and extensions to simplify and standardize API development.

Features

Controllers

  • BaseController.cs: A foundational controller class for building APIs with shared functionality.

Extensions

  • Common:

    • ClaimExtensions.cs: Utilities for working with claims.
    • HttpContextExtensions.cs: Helpers for managing HTTP context operations.
    • SecurityConfiguration.cs: Configuration utilities for securing APIs.

  • DI (Dependency Injection):

    • Helpers for setting up application services and configurations:
      • AddApiConfigurationExtensions.cs
      • AddApplicationServiceExtensions.cs
      • AddArkaSoftwareServicesExtensions.cs
      • AddDataAccessExtensions.cs
      • Extensions.cs

  • ModelBinding:

    • NonValidatingValidatorExtensions.cs: Utilities for flexible model validation.

Filters

  • TrackActionPerformanceFilter.cs: A filter for tracking action execution performance.
  • ValidateModelStateAttribute.cs: Attribute for validating model state in controllers.

Middlewares

  • ApiError.cs: A standardized model for API error responses.
  • ApiExceptionMiddleware.cs: Middleware for handling API exceptions.
  • ApiExceptionMiddlewareExtensions.cs: Extensions for adding exception middleware to the pipeline.
  • ApiExceptionOptions.cs: Options for configuring API exception handling.

ModelBinding

  • NonValidatingValidator.cs: A validator for handling models without validation.

Installation and Usage

  1. Add this library to your project:

    dotnet add package Arks.Framework.Endpoints.Web

  2. Use the provided base controller and middleware for consistent API development.

  3. Leverage filters and extensions to simplify dependency injection and HTTP operations.

Contribution

If you want to contribute to this project:

  1. Fork the repository.
  2. Make your changes.
  3. Submit a Pull Request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For inquiries or issues, please reach out to your.email@example.com.

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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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
2.0.0 162 1/24/2025
1.0.1 137 1/24/2025