ForgeTrust.AppSurface.Web.OpenApi
0.1.0-preview.2
This is a prerelease version of ForgeTrust.AppSurface.Web.OpenApi.
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package ForgeTrust.AppSurface.Web.OpenApi --version 0.1.0-preview.2
NuGet\Install-Package ForgeTrust.AppSurface.Web.OpenApi -Version 0.1.0-preview.2
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="ForgeTrust.AppSurface.Web.OpenApi" Version="0.1.0-preview.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="ForgeTrust.AppSurface.Web.OpenApi" Version="0.1.0-preview.2" />
<PackageReference Include="ForgeTrust.AppSurface.Web.OpenApi" />
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 ForgeTrust.AppSurface.Web.OpenApi --version 0.1.0-preview.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: ForgeTrust.AppSurface.Web.OpenApi, 0.1.0-preview.2"
#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 ForgeTrust.AppSurface.Web.OpenApi@0.1.0-preview.2
#: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=ForgeTrust.AppSurface.Web.OpenApi&version=0.1.0-preview.2&prerelease
#tool nuget:?package=ForgeTrust.AppSurface.Web.OpenApi&version=0.1.0-preview.2&prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
ForgeTrust.AppSurface.Web.OpenApi
This package provides a modular integration for OpenAPI (Swagger) document generation in AppSurface web applications.
Overview
The AppSurfaceWebOpenApiModule simplifies the configuration of OpenAPI by:
- Registering the necessary services via
AddOpenApi. - Configuring the
EndpointsApiExplorer. - Automatically mapping the OpenAPI documentation endpoints.
- Providing default document and operation transformers to clean up and brand the generated documentation based on the
StartupContext.
Usage
To enable OpenAPI support in your application, add the AppSurfaceWebOpenApiModule as a dependency in your root module:
public class MyModule : IAppSurfaceWebModule
{
public void RegisterDependentModules(ModuleDependencyBuilder builder)
{
builder.AddModule<AppSurfaceWebOpenApiModule>();
}
// ...
}
Features
- Document Transformation: Automatically updates the API title and tags based on the application name defined in the
StartupContext. - Automatic Endpoint Mapping: Calls
endpoints.MapOpenApi()for you during the endpoint configuration phase.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. 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.
-
net10.0
- ForgeTrust.AppSurface.Web (>= 0.1.0-preview.2)
- Microsoft.AspNetCore.OpenApi (>= 9.0.8)
- Microsoft.Extensions.Hosting (>= 9.0.6)
- Microsoft.Extensions.Logging.Console (>= 9.0.6)
- Microsoft.Extensions.Options (>= 9.0.6)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on ForgeTrust.AppSurface.Web.OpenApi:
| Package | Downloads |
|---|---|
|
ForgeTrust.AppSurface.Web.Scalar
ForgeTrust.AppSurface.Web.Scalar package for AppSurface application composition. |
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 0.2.0-preview.8 | 86 | 8/23/2026 |
| 0.2.0-preview.7 | 90 | 8/16/2026 |
| 0.2.0-preview.6 | 75 | 8/12/2026 |
| 0.2.0-preview.5 | 83 | 8/1/2026 |
| 0.2.0-preview.4 | 83 | 7/18/2026 |
| 0.2.0-preview.2 | 77 | 7/3/2026 |
| 0.2.0-preview.1 | 78 | 6/28/2026 |
| 0.1.0 | 159 | 7/2/2026 |
| 0.1.0-rc.4 | 87 | 6/16/2026 |
| 0.1.0-rc.3 | 79 | 6/8/2026 |
| 0.1.0-rc.2 | 78 | 6/3/2026 |
| 0.1.0-rc.1 | 77 | 5/31/2026 |
| 0.1.0-preview.4 | 79 | 5/25/2026 |
| 0.1.0-preview.3 | 80 | 5/20/2026 |
| 0.1.0-preview.2 | 77 | 5/14/2026 |