VOOZH about

URL: https://www.nuget.org/packages/OrchardCoreContrib.Apis.Swagger/

⇱ NuGet Gallery | OrchardCoreContrib.Apis.Swagger 1.6.0



👁 Image
 OrchardCoreContrib.Apis.Swagger 1.6.0

Prefix Reserved 
dotnet add package OrchardCoreContrib.Apis.Swagger --version 1.6.0
 
 
NuGet\Install-Package OrchardCoreContrib.Apis.Swagger -Version 1.6.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="OrchardCoreContrib.Apis.Swagger" Version="1.6.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="OrchardCoreContrib.Apis.Swagger" Version="1.6.0" />
 


 Directory.Packages.props
 

 

 
<PackageReference Include="OrchardCoreContrib.Apis.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 OrchardCoreContrib.Apis.Swagger --version 1.6.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support. 
#r "nuget: OrchardCoreContrib.Apis.Swagger, 1.6.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 OrchardCoreContrib.Apis.Swagger@1.6.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=OrchardCoreContrib.Apis.Swagger&version=1.6.0
 


 Install as a Cake Addin
 

 

 
#tool nuget:?package=OrchardCoreContrib.Apis.Swagger&version=1.6.0
 


 Install as a Cake Tool
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Swagger Module

This module allows you to create APIs documentations using Swagger.

Version

1.6.0

Category

Api

Dependencies

This module has no dependencies.

Features
Name Swagger (OrchardCoreContrib.Apis.Swagger)
Description Enables Swagger for OrchardCore APIs.
Dependencies
Name Swagger (OrchardCoreContrib.Apis.Swagger.UI)
Description Enables Swagger UI for OrchardCore APIs.
Dependencies OrchardCoreContrib.Apis.Swagger

NuGet Packages

Name Version
OrchardCoreContrib.Apis.Swagger 1.6.0
OrchardCoreContrib.Apis.Swagger 1.5.0
OrchardCoreContrib.Apis.Swagger 1.4.1
OrchardCoreContrib.Apis.Swagger 1.4.0
OrchardCoreContrib.Apis.Swagger 1.3.0
OrchardCoreContrib.Apis.Swagger 1.2.0
OrchardCoreContrib.Apis.Swagger 1.1.0
OrchardCoreContrib.Apis.Swagger 1.0.1
OrchardCoreContrib.Apis.Swagger 1.0.0

Get Started

  1. Install the OrchardCoreContrib.Apis.Swagger NuGet package to your Orchard Core host project.
  2. Go to the admin site
  3. Select Configuration → Features menu.

Swagger

  1. Enable the Swagger feature.
  2. Go to the {tenant-URL}/swagger/v1.0.0/swagger.json, you should see all the APIs listed in JSON format.

Swagger UI

  1. Enable the Swagger UI feature.
  2. Go to the {tenant-URL}/swagger/index.html, you should see all the APIs listed in a pretty styled page.

How to get my APIs into Swagger docs?

Adding your APIs is not swagger docs is not a difficult task, simply you need:

  1. Add ApiController.
  2. Annotate the controller with [Route("api/{module}")].
  3. Add your HttpGet or HttpPost methods into your contoller.
  4. Then your APIs should be displayed into the swagger docs.

So, If you tried to enable Lucene or Queries modules for instance, their APIs will show up immediately in the swagger docs. That's because every module defined an ApiController in the same way that mentioned above.

For more information about swagger, please refer to ASP.NET Core web API documentation with Swagger / OpenAPI.

Video

Product Versions Compatible and additional computed target framework versions.
.NET net8.0 net8.0 is compatible.  net8.0-android net8.0-android was computed.  net8.0-browser net8.0-browser was computed.  net8.0-ios net8.0-ios was computed.  net8.0-maccatalyst net8.0-maccatalyst was computed.  net8.0-macos net8.0-macos was computed.  net8.0-tvos net8.0-tvos was computed.  net8.0-windows net8.0-windows was computed.  net9.0 net9.0 was computed.  net9.0-android net9.0-android was computed.  net9.0-browser net9.0-browser was computed.  net9.0-ios net9.0-ios was computed.  net9.0-maccatalyst net9.0-maccatalyst was computed.  net9.0-macos net9.0-macos was computed.  net9.0-tvos net9.0-tvos was computed.  net9.0-windows net9.0-windows was computed.  net10.0 net10.0 was computed.  net10.0-android net10.0-android was computed.  net10.0-browser net10.0-browser was computed.  net10.0-ios net10.0-ios was computed.  net10.0-maccatalyst net10.0-maccatalyst was computed.  net10.0-macos net10.0-macos was computed.  net10.0-tvos net10.0-tvos was computed.  net10.0-windows 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
1.6.0 2,445 11/28/2025
1.5.0 3,848 11/22/2024
1.4.1 6,019 4/26/2024
1.4.0 389 4/24/2024
1.3.0 7,054 9/22/2023
1.2.0 13,596 1/28/2023
1.1.0 4,186 3/6/2022
1.0.1 641 2/12/2022
1.0.0 660 2/2/2022

https://github.com/OrchardCoreContrib/OrchardCoreContrib.Modules/releases