OpenAPIExport.MSBuild
1.3.0
dotnet add package OpenAPIExport.MSBuild --version 1.3.0
NuGet\Install-Package OpenAPIExport.MSBuild -Version 1.3.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="OpenAPIExport.MSBuild" Version="1.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add OpenAPIExport.MSBuild --version 1.3.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: OpenAPIExport.MSBuild, 1.3.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.
// Install OpenAPIExport.MSBuild as a Cake Addin
#addin nuget:?package=OpenAPIExport.MSBuild&version=1.3.0
// Install OpenAPIExport.MSBuild as a Cake Tool
#tool nuget:?package=OpenAPIExport.MSBuild&version=1.3.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
OpenAPIExport.MSBuild
MSBuild props for automatically exporting api swagger doc files.
Getting started
- Add OpenAPIExport.MSBuild nuget package to api project
- During build the api project starts and downloads its swagger doc
- Enjoy automatic swagger doc export
Configuration options
Threre are some configuration options for the MSBuild task executed during api build.
OpenApiExportPath: file path for saving swagger doc (default:$(SolutionDirectory)/doc/api-doc.yaml)OpenApiExportPort: port where the build time api runs on (default:5005)OpenApiExportSource: relative source path of swagger doc (default:swagger/v1/swagger.yaml)OpenApiExportRetryCount: specify how many retries are made for downloading the swagger doc (default:5)OpenApiExportRetryInterval: specify the waiting time in seconds before every downloading try (default:2)
There are no supported framework assets in this package.
Learn more about Target Frameworks and .NET Standard.
-
net6.0
- Microsoft.Build.Framework (>= 17.9.5)
- Microsoft.Build.Utilities.Core (>= 17.9.5)
-
net7.0
- Microsoft.Build.Framework (>= 17.9.5)
- Microsoft.Build.Utilities.Core (>= 17.9.5)
-
net8.0
- Microsoft.Build.Framework (>= 17.9.5)
- Microsoft.Build.Utilities.Core (>= 17.9.5)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.