Simplify.Web.Swagger 0.4.1

dotnet add package Simplify.Web.Swagger --version 0.4.1
NuGet\Install-Package Simplify.Web.Swagger -Version 0.4.1
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="Simplify.Web.Swagger" Version="0.4.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Simplify.Web.Swagger --version 0.4.1
#r "nuget: Simplify.Web.Swagger, 0.4.1"
#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 Simplify.Web.Swagger as a Cake Addin
#addin nuget:?package=Simplify.Web.Swagger&version=0.4.1

// Install Simplify.Web.Swagger as a Cake Tool
#tool nuget:?package=Simplify.Web.Swagger&version=0.4.1

Simplify.Web.Swagger

Nuget Version Nuget Download Build Package Libraries.io dependency status for latest release CodeFactor Grade Platform PRs Welcome

Simplify.Web.Swagger is a package which provides Swagger generation for Simplify.Web web-framework controllers.

Quick Start

  1. Add Simplify.Web.Swagger, Swashbuckle.AspNetCore.SwaggerGen and Swashbuckle.AspNetCore.SwaggerUI packages to your project
<PackageReference Include="Simplify.Web.Swagger" Version="0.1.*" />
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerGen" Version="6.3.*" />
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="6.3.*" />
  1. Add AddSimplifyWebSwagger in AddSwaggerGen registration and Simplify.Web controllers will be scanned during Swagger generation process.
var builder = WebApplication.CreateBuilder(args);

builder.Services.AddEndpointsApiExplorer()
 .AddSwaggerGen(x => x.AddSimplifyWebSwagger());
  1. Use Swagger as in regular ASP.NET Core project
var app = builder.Build();

app.UseSwagger();
app.UseSwaggerUI();

app.UseSimplifyWebWithoutRegistrations();

app.Run();
  1. Add controller Swagger attributes (if needed)
[Get("/api/v1/users/{id:int}")]
[ApiVersion("1.0")]
[ProducesResponse(StatusCodes.Status200OK, "application/json")]
[ProducesResponse(StatusCodes.Status500InternalServerError)]
public class GetController : Simplify.Web.Controller
{
 ...
}
  1. After application started go to http://localhost:5000/swagger/index.html or http://localhost:5000/swagger/v1/swagger.json to see generated Swagger

Example application

Below is the example of Swagger generated by Simplify.Web.Swagger:

Simplify

Contributing

There are many ways in which you can participate in the project. Like most open-source software projects, contributing code is just one of many outlets where you can help improve. Some of the things that you could help out with are:

  • Documentation (both code and features)
  • Bug reports
  • Bug fixes
  • Feature requests
  • Feature implementations
  • Test coverage
  • Code quality
  • Sample applications

Additional extensions to Simplify.Web live in their own repositories on GitHub. For example:

License

Licensed under the GNU LESSER GENERAL PUBLIC LICENSE

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  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 netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos 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
0.4.1 162 12/22/2023
0.4.0 106 12/21/2023
0.3.0 84 12/20/2023
0.2.0 442 6/14/2022
0.1.0 403 5/11/2022