Mvp24Hours.WebAPI 3.1.101

.NET Core 3.1 This package targets .NET Core 3.1. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Mvp24Hours.WebAPI --version 3.1.101                

                    
                

            
NuGet\Install-Package Mvp24Hours.WebAPI -Version 3.1.101
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="Mvp24Hours.WebAPI" Version="3.1.101" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Mvp24Hours.WebAPI --version 3.1.101                

                    
                

            
#r "nuget: Mvp24Hours.WebAPI, 3.1.101"
#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 Mvp24Hours.WebAPI as a Cake Addin
#addin nuget:?package=Mvp24Hours.WebAPI&version=3.1.101

// Install Mvp24Hours.WebAPI as a Cake Tool
#tool nuget:?package=Mvp24Hours.WebAPI&version=3.1.101

Documentation

The habit of documenting interfaces and data classes (value objects, dtos, entities, ...) can contribute to facilitate code maintenance.

Swagger

Swagger allows you to easily document your RESTful API by sharing with other developers how they can consume available resources.

Installation

/// Package Manager Console >
Install-Package Mvp24Hours.WebAPI

Configuration

/// Startup.cs
services.AddMvp24HoursSwagger(
    "Name API",
    version: "v1");

To present comments, just enable "XML Documentation File" and generate build.

/// NameAPI.WebAPI.csproj
// configure project to extract comments
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
    <DocumentationFile>.\NameAPI.WebAPI.xml</DocumentationFile>
</PropertyGroup>

/// Startup.cs
services.AddMvp24HoursSwagger(
    "Pipeline API",
    version: "v1",
    xmlCommentsFileName: "NameAPI.WebAPI.xml");

To present code examples use "enableExample" in the registry and the "example" tag in the comments:

/// Startup.cs
services.AddMvp24HoursSwagger(
    "Pipeline API",
    version: "v1",
    enableExample: true);

/// WeatherForecast.cs -> Model
public class WeatherForecast
{
    /// <summary>
    /// The date of the forecast in ISO-whatever format
    /// </summary>
    public DateTime Date { get; set; }

    /// <summary>
    /// Temperature in celcius
    /// </summary>
    /// <example>25</example>
    public int TemperatureC { get; set; }

    public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);

    /// <summary>
    /// A textual summary
    /// </summary>
    /// <example>Cloudy with a chance of rain</example>
    public string Summary { get; set; }
}

/// WeatherController.cs
[HttpPost]
[Route("", Name = "WeatherPost")]
public IActionResult Post(WeatherForecast forecast)
{
    // ...
}

To present security lock for requests with authorization "Bearer" or "Basic" do:

/// Startup.cs
services.AddMvp24HoursSwagger(
    "Name API",
    version: "v1",
    oAuthScheme: SwaggerAuthorizationScheme.Bearer); // SwaggerAuthorizationScheme.Basic

If you have a custom type to work with authorizations, just register:

/// Startup.cs
services.AddMvp24HoursSwagger(
    "Name API",
    version: "v1",
    oAuthScheme: SwaggerAuthorizationScheme.Bearer, // SwaggerAuthorizationScheme.Basic
    authTypes: new Type[] { typeof(AuthorizeAttribute) });
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
8.7.151 62 7/15/2024
8.3.261 107 3/26/2024
8.2.102 150 2/9/2024
8.2.101 94 2/7/2024
4.1.191 128 1/19/2024
4.1.181 82 1/19/2024
3.12.262 138 12/26/2023
3.12.261 78 12/26/2023
3.12.221 109 12/22/2023
3.12.151 138 12/17/2023
3.6.221 4,128 6/22/2022
3.4.111 792 4/11/2022
3.2.241 517 2/24/2022
3.2.171 457 2/17/2022
3.2.151 424 2/15/2022
3.2.142 405 2/14/2022
3.2.141 402 2/14/2022
3.2.21 441 2/2/2022
3.1.243 438 1/25/2022
3.1.242 465 1/24/2022
3.1.241 434 1/24/2022
3.1.221 448 1/22/2022
3.1.201 435 1/20/2022
3.1.101 434 1/10/2022
2.12.291 341 12/29/2021
2.12.102 404 12/10/2021
2.12.101 356 12/10/2021
2.12.71 335 12/7/2021
2.11.241 4,305 11/24/2021
1.9.81 496 9/8/2021
1.7.61 523 7/6/2021
1.6.251 420 6/25/2021
1.6.101 433 6/10/2021
1.5.311 672 5/31/2021
1.5.281 537 5/28/2021
1.5.171 683 5/17/2021
1.5.141 437 5/14/2021
1.5.132 440 5/13/2021
1.5.131 394 5/13/2021
1.4.301 393 4/30/2021
1.4.221 359 4/22/2021
1.4.220 362 4/22/2021
1.4.120 358 4/12/2021
1.4.82 367 4/9/2021
1.4.81 346 4/8/2021
1.4.21 356 4/2/2021
1.4.20 331 4/2/2021
1.0.20 352 4/2/2021
1.0.19 359 4/1/2021
1.0.18 394 3/16/2021
1.0.17 367 3/15/2021
1.0.16 363 3/15/2021
1.0.15 386 3/8/2021
1.0.12 350 3/2/2021
1.0.11 337 3/1/2021
1.0.10 340 2/12/2021
1.0.9 327 2/11/2021
1.0.8 324 2/11/2021
1.0.7 339 2/11/2021
1.0.6 332 2/11/2021
1.0.5 339 2/11/2021
1.0.4 349 2/11/2021
1.0.3 362 2/9/2021
1.0.2 331 2/3/2021
1.0.1 415 2/1/2021
1.0.0 391 1/29/2021