Core.SimpleStandardApiResponse 1.0.0

.NET Core 3.1
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Core.SimpleStandardApiResponse --version 1.0.0
NuGet\Install-Package Core.SimpleStandardApiResponse -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="Core.SimpleStandardApiResponse" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Core.SimpleStandardApiResponse --version 1.0.0
#r "nuget: Core.SimpleStandardApiResponse, 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. 
// Install Core.SimpleStandardApiResponse as a Cake Addin
#addin nuget:?package=Core.SimpleStandardApiResponse&version=1.0.0

// Install Core.SimpleStandardApiResponse as a Cake Tool
#tool nuget:?package=Core.SimpleStandardApiResponse&version=1.0.0

How to use

The following status codes and corresponding response models are:

  • 200 (OK) : OkApiResponse
  • 201 (Created) : CreatedApiResponse
  • 400 (BadRequest) : BadRequestApiResponse
  • 401 (Unauthorized) : UnauthorizedApiResponse
  • 403 (Forbidden) : ForbiddenApiResponse
  • 404 (NotFound) : NotFoundApiResponse
  • 500 (InternalServerError) : InternalServerErrorApiResponse

The base class ApiResponse is also available to override for other Response Statuses.

There is also the ResponseMessage model with the following propeties:

  • Status : int
  • Payload : ApiResponse (base class)

Responses

The following models have the following properties:

  • ApiResponse :
    • Status : int (HttpStatusCode of the Response Model)
    • Title : string (Default title of the HttpStatusCode. Can be overridden)
    • RequestDate : DateTime (DateTime of the request)
  • OkApiResponse :
    • Result : object (To be set to whatever the requested resource is)
  • CreatedApiResponse :
    • Id : object (to be set to whatever the created resource is)
  • BadRequest :
    • Errors : object (To be set to the validation errors)
    • The model will convert a ModelStateDictionary to a Dictionary of the errors for you
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
.NET Core netcoreapp3.1 is compatible. 
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.1 459 4/19/2020
1.0.0 412 4/19/2020