Simplify.Web.Swagger
0.2.0
.NET 6.0
.NET Standard 2.0
dotnet add package Simplify.Web.Swagger --version 0.2.0
NuGet\Install-Package Simplify.Web.Swagger -Version 0.2.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="Simplify.Web.Swagger" Version="0.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Simplify.Web.Swagger --version 0.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Simplify.Web.Swagger, 0.2.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 Simplify.Web.Swagger as a Cake Addin
#addin nuget:?package=Simplify.Web.Swagger&version=0.2.0
// Install Simplify.Web.Swagger as a Cake Tool
#tool nuget:?package=Simplify.Web.Swagger&version=0.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Simplify.Web.Swagger
Simplify.Web.Swagger is a package which provides Swagger generation for Simplify.Web web-framework controllers.
Quick Start
- Add
Simplify.Web.Swagger,Swashbuckle.AspNetCore.SwaggerGenandSwashbuckle.AspNetCore.SwaggerUIpackages 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.*" />
- Add
AddSimplifyWebSwaggerinAddSwaggerGenregistration andSimplify.Webcontrollers will be scanned during Swagger generation process.
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddEndpointsApiExplorer()
.AddSwaggerGen(x => x.AddSimplifyWebSwagger());
- Use Swagger as in regular ASP.NET Core project
var app = builder.Build();
app.UseSwagger();
app.UseSwaggerUI();
app.UseSimplifyWebWithoutRegistrations();
app.Run();
- 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
{
...
}
- 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:
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
Related Projects
Additional extensions to Simplify.Web live in their own repositories on GitHub. For example:
- Simplify.Web.Json - JSON serialization/deserialization
- Simplify.Web.Multipart - multipart form model binder
- Simplify.Web.MessageBox - non-interactive server side message box
- Simplify.Web.Templates - Visual studio project templates
License
Licensed under the GNU LESSER GENERAL PUBLIC LICENSE
| Product | Versions |
|---|---|
| .NET | net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows |
| .NET Core | netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1 |
| .NET Standard | netstandard2.0 netstandard2.1 |
| .NET Framework | net461 net462 net463 net47 net471 net472 net48 net481 |
| MonoAndroid | monoandroid |
| MonoMac | monomac |
| MonoTouch | monotouch |
| Tizen | tizen40 tizen60 |
| Xamarin.iOS | xamarinios |
| Xamarin.Mac | xamarinmac |
| Xamarin.TVOS | xamarintvos |
| Xamarin.WatchOS | xamarinwatchos |
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- Microsoft.AspNetCore.Mvc.Versioning (>= 4.1.0)
- Simplify.Web (>= 4.6.0)
- Swashbuckle.AspNetCore.SwaggerGen (>= 6.3.1)
-
net6.0
- Microsoft.AspNetCore.Mvc.Versioning (>= 4.1.0)
- Simplify.Web (>= 4.6.0)
- Swashbuckle.AspNetCore.SwaggerGen (>= 6.3.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.