ICode.SwaggerHelpers
1.0.12
dotnet add package ICode.SwaggerHelpers --version 1.0.12
NuGet\Install-Package ICode.SwaggerHelpers -Version 1.0.12
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="ICode.SwaggerHelpers" Version="1.0.12" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="ICode.SwaggerHelpers" Version="1.0.12" />
<PackageReference Include="ICode.SwaggerHelpers" />
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 ICode.SwaggerHelpers --version 1.0.12
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: ICode.SwaggerHelpers, 1.0.12"
#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 ICode.SwaggerHelpers@1.0.12
#: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=ICode.SwaggerHelpers&version=1.0.12
#tool nuget:?package=ICode.SwaggerHelpers&version=1.0.12
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
ICode.SwaggerHelpers
Enhanced Swagger/OpenAPI documentation helpers for ASP.NET Core, providing rich metadata attributes and filters for better API documentation.
Features
- Rich metadata attributes for API documentation
- Support for multiple OpenAPI specifications
- Enhanced operation descriptions and summaries
- Support for tags, content types, and security schemes
- External documentation linking
- Deprecation marking
- Multi-targeting support (.NET 6.0 through .NET 8.0)
Installation
dotnet add package ICode.SwaggerHelpers
Usage
1. Register the Document Filter
In your Startup.cs or Program.cs:
builder.Services.AddSwaggerGen(c =>
{
c.DocumentFilter<DocumentSwaggerFilter>();
});
2. Use the SwaggerOperation Attribute
[SwaggerOperation("GetUser", "Gets a user by ID") {
Tags = new[] { "Users" },
Consumes = new[] { "application/json" },
Produces = new[] { "application/json" },
SecurityRequirements = new[] { "Bearer" },
ExternalDocsUrl = "https://api.example.com/docs/users",
ExternalDocsDescription = "User API Documentation"
}]
[HttpGet("users/{id}")]
public IActionResult GetUser(int id)
{
// Your implementation
}
Available Properties
Key: Operation identifierDescription: Detailed operation descriptionSummary: Short operation summaryTags: API documentation grouping tagsConsumes: Supported request content typesProduces: Supported response content typesDeprecated: Mark operation as deprecatedSecurityRequirements: Required security schemesExternalDocsUrl: Link to external documentationExternalDocsDescription: Description of external documentation
License
This project is licensed under the MIT License.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | 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 is compatible. 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 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.
-
net6.0
- Swashbuckle.AspNetCore.SwaggerGen (>= 8.1.2)
-
net7.0
- Swashbuckle.AspNetCore.SwaggerGen (>= 8.1.2)
-
net8.0
- Swashbuckle.AspNetCore.SwaggerGen (>= 8.1.2)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.