SwaggerGenerator.Core
1.0.0
dotnet add package SwaggerGenerator.Core --version 1.0.0
NuGet\Install-Package SwaggerGenerator.Core -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="SwaggerGenerator.Core" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="SwaggerGenerator.Core" Version="1.0.0" />
<PackageReference Include="SwaggerGenerator.Core" />
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 SwaggerGenerator.Core --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: SwaggerGenerator.Core, 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.
#:package SwaggerGenerator.Core@1.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=SwaggerGenerator.Core&version=1.0.0
#tool nuget:?package=SwaggerGenerator.Core&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Swagger Generator C#
this nuget base on NSwag
How to use (Startup.cs)
using SwaggerGenerator;
public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
.
.
.
services.AddAutoGeneratedSwagger();
.
.
.
}
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
.
.
.
app.UseAutoGeneratedSwagger();
.
.
.
}
}
Example of attributes
using SwaggerGenerator;
using System.Collections.Generic;
using System.ComponentModel;
using System;
using System.ComponentModel.DataAnnotations;
using Newtonsoft.Json;
public class AttributesExample
{
[JsonProperty(Order = 101)] public string LastProp { get; set; }
[Description("my desc")] public string HaveDescription { get; set; }
[Display(Name = "display name")] public string HaveTitle { get; set; }
[Obsolete] public bool? Deprecated { get; set; }
public bool HaveDefaultValue { get; set; } = true;
[RegularExpression("https?:\\/\\/(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\\+.~#?&\\/\\/=]*)")] public string HavePattern { get; set; }
[StringLength(100, MinimumLength = 10)] public string HaveLength { get; set; }
[MinLength(10), MaxLength(100)] public string HaveLength2 { get; set; }
[Range(10, 100)] public int HaveRange { get; set; }
[MinLength(2), MaxLength(100)] public List<string> ListMinMaxItems { get; set; }
[SwaggerUniqueItems] public List<string> UniqueList { get; set; }
// one of those attributes
[BsonIgnore,JsonIgnore,ForeignKey,InverseProperty,SwaggerExclude] public object HideProp { get; set; }
// only DogType will be in the swagger
[SwaggerIgnoreInheritProps] public Dog DogWithoutInheritProps { get; set; }
}
public class Animal
{
public string Name { get; set; }
public int Age { get; set; }
}
public class Dog : Animal
{
public string DogType { get; set; }
}
| Product | Versions 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. 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. |
| .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.
-
.NETStandard 2.0
- Microsoft.AspNetCore.Http.Abstractions (>= 2.2.0)
- Microsoft.AspNetCore.StaticFiles (>= 2.2.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 5.0.0)
- MongoDB.Bson (>= 2.12.4)
- Newtonsoft.Json (>= 13.0.1)
- Newtonsoft.Json.Bson (>= 1.0.2)
- NSwag.AspNetCore (>= 13.11.3)
- NSwag.Generation (>= 13.11.3)
- System.ComponentModel.Annotations (>= 5.0.0)
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.0 | 678 | 6/25/2021 |