Chronos.ApiResponse 1.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Chronos.ApiResponse --version 1.0.0
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Chronos.ApiResponse" />
                    


                            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 Chronos.ApiResponse --version 1.0.0
                    


                    

                
#r "nuget: Chronos.ApiResponse, 1.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 Chronos.ApiResponse@1.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=Chronos.ApiResponse&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Chronos.ApiResponse&version=1.0.0
                    


                            Install as a Cake Tool

Chronos ApiResponse

Chronos.ApiResponse is a package designed to simplify the process of creating custom API responses by providing basic implementations. This package helps developers quickly set up and manage their API responses, reducing the time and effort required for this task.

Requirements

Authors

Usage/Examples

Here is an Example for returning a paginated response:

public async Task<IActionResult> GetAllProducts([FromQuery] ProductParameter productParameter)
{
        var query = new GetAllProductsQuery(productParameter);
        var pagedList = await _mediator.Send(query);
        return ApiResponseExtension.ToPaginatedApiResult(pagedList, "products", "200", pagedList.MetaData.CurrentPage,
        pagedList.MetaData.TotalPages);
}

Example for using individual responses:

public async Task<IActionResult> GetProductByName([FromQuery] string productName)
{
        var query = new GetProductByNameQuery(productName);
        var product = await _mediator.Send(query);
        if (product == null)
        {
            return ApiResponseExtension.ToErrorApiResult("Not Found", $"Product with name {productName} not found",
                "404");
        }
        return ApiResponseExtension.ToSuccessApiResult(product, "Product");
}

License

MIT

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
1.0.0 181 6/14/2024