n-ate.Swagger 8.0.0

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package n-ate.Swagger --version 8.0.0
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="n-ate.Swagger" />
                    


                            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 n-ate.Swagger --version 8.0.0
                    


                    

                
#r "nuget: n-ate.Swagger, 8.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 n-ate.Swagger@8.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=n-ate.Swagger&version=8.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=n-ate.Swagger&version=8.0.0
                    


                            Install as a Cake Tool

n-ate n-ate Swagger Package

Note, if using this README from Visual Studio you may want to install a markdown editor extension.

Quick start with general API setup.

For authorization of a client application see the client authorization guide.

Package Features: The n-ate Swagger package provides tooling common to API projects shortening development time and enhancing Swagger pages for greater utility. The following significant features are available in this package:

Other minor features available in this package:

  • listing all registered routes
  • Preventing GET endpoint caching
  • Defining querystring variables

For a visual summary of Swagger page features click here.

//TODO: Ensure each of the following features are properly documented:

Audit Routes Endpoint
    required configuration
        AddFreshSwaggerGen()
        AddControllers()    
        UseFreshSwagger()
        UseEndpoints()
        MapControllers()
        MapAuditEndpoint()

Swagger UI Configuration

 options.InjectDefaultExplanationHtml("<h1>Hello World!</h1>");
 options.InjectExplanationFile(FreshVersion.Get("test-v1.1"), @"wwwroot\html\fragments\swagger-test-definition-explanation.html");

 options.InjectOperationsFilter();

 options.OnDefinitionLoadExecuteScript(@"console.log(""OnDefinitionLoadExecuteScript() executed successfully again!"");");
 options.OnDefinitionLoadExecuteScript(@"console.log(""OnDefinitionLoadExecuteScript() executed successfully!"");");

 options.SpecifyStracktraceFormattingField("api-execution-stack");
 options.SpecifyStracktraceFormattingField("stack");

 options.UseAutomaticAuthorization();

List of attributes used by this package:

Attribute name Attribute Namespace
Authorize Microsoft.AspNetCore.Authorization
ApiController Microsoft.AspNetCore.Mvc
FreshApiVersion n_ate.Swagger
ControllerName Microsoft.AspNetCore.Mvc
HttpDelete Microsoft.AspNetCore.Mvc
HttpGet Microsoft.AspNetCore.Mvc
HttpPatch Microsoft.AspNetCore.Mvc
HttpPost Microsoft.AspNetCore.Mvc
HttpPut Microsoft.AspNetCore.Mvc
NoCache n_ate.Swagger
Produces Microsoft.AspNetCore.Mvc
ProducesResponseType Microsoft.AspNetCore.Mvc
QueryStringParameter n_ate.Swagger
RequiresRequestType n_ate.Swagger
Route Microsoft.AspNetCore.Mvc
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
8.0.0 218 5/27/2024