OrchardCoreContrib.Apis.Swagger 1.6.0

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
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
                    


                    

                
#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

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

Watch the video

Product Compatible and additional computed target framework versions.
.NET 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.

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 151 11/28/2025
1.5.0 2,838 11/22/2024
1.4.1 4,202 4/26/2024
1.4.0 302 4/24/2024
1.3.0 6,899 9/22/2023
1.2.0 13,003 1/28/2023
1.1.0 4,129 3/6/2022
1.0.1 599 2/12/2022
1.0.0 604 2/2/2022

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