Workleap.OpenApi.MSBuild
0.10.0
Prefix Reserved
See the version list below for details.
dotnet add package Workleap.OpenApi.MSBuild --version 0.10.0
NuGet\Install-Package Workleap.OpenApi.MSBuild -Version 0.10.0
<PackageReference Include="Workleap.OpenApi.MSBuild" Version="0.10.0"> <PrivateAssets>all</PrivateAssets> <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets> </PackageReference>
paket add Workleap.OpenApi.MSBuild --version 0.10.0
#r "nuget: Workleap.OpenApi.MSBuild, 0.10.0"
// Install Workleap.OpenApi.MSBuild as a Cake Addin #addin nuget:?package=Workleap.OpenApi.MSBuild&version=0.10.0 // Install Workleap.OpenApi.MSBuild as a Cake Tool #tool nuget:?package=Workleap.OpenApi.MSBuild&version=0.10.0
Workleap.OpenApi.MSBuild
Validates at build time that the OpenAPI specification files extracted from the ASP.NET Core Web API being built conform to Workleap API guidelines.
Depending if the user chose the ValidateContract or GenerateContract development mode this MSBuild task will:
- Install tools: OasDiff, Spectral, SwashbuckleCLI
- Generate the OpenAPI specification file from the associated Web API
- Validate OpenAPI spec with Workleap Spectral rules
- Compare the given OpenAPI specification file with the generated one
How it works
For the TLDR version:
- The entry point is
ValidateOpenApiTask.ExecuteAsync()
and will be executed after the referencing project is built. This is defined in./src/Workleap.OpenApi.MSBuild/msbuild/tools/Workleap.OpenApi.MSBuild.targets
as aUsingTask.TaskName
- The default value are defined in the property group on the target
ValidateOpenApi
in this file./src/Workleap.OpenApi.MSBuild/msbuild/tools/Workleap.OpenApi.MSBuild.targets
- Users can select whether to validate the API with frontend or backend ruleset depending on how they configure the
OpenApiServiceProfile
MSBuild property (backend
(default) orfrontend
).
How to test locally
How debug the project
Since it's a MSBuild task named ValidateOpenApi
you can run it this command: msbuild /t:ValidateOpenApi
. ./src/WebApiDebugger
already have some preconfigured in launchSettings.json
that you can run in debug.
Note: Before executing this task it will build the project.
Warming: validate your IDE is in Configuration:Debug otherwise the execution will not be done on the most recent code.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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 was computed. 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 was computed. 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. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- CliWrap (>= 3.6.6)
- Microsoft.Build.Utilities.Core (>= 17.10.4)
- YamlDotNet (>= 16.1.3)
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 |
---|---|---|
0.10.1-preview.2 | 42 | 12/18/2024 |
0.10.1-preview.1 | 40 | 12/17/2024 |
0.10.0 | 190 | 12/10/2024 |
0.9.1-preview.27 | 40 | 10/30/2024 |
0.9.1-preview.26 | 42 | 10/28/2024 |
0.9.1-preview.25 | 38 | 10/28/2024 |
0.9.1-preview.24 | 42 | 10/28/2024 |
0.9.1-preview.23 | 50 | 10/2/2024 |
0.9.1-preview.22 | 52 | 10/1/2024 |
0.9.1-preview.21 | 43 | 10/1/2024 |
0.9.1-preview.20 | 49 | 10/1/2024 |
0.9.1-preview.19 | 42 | 10/1/2024 |
0.9.1-preview.18 | 49 | 9/30/2024 |
0.9.1-preview.17 | 50 | 8/27/2024 |
0.9.1-preview.16 | 46 | 8/27/2024 |
0.9.1-preview.15 | 44 | 8/27/2024 |
0.9.1-preview.14 | 70 | 8/16/2024 |
0.9.1-preview.13 | 73 | 8/16/2024 |
0.9.1-preview.12 | 67 | 8/16/2024 |
0.9.1-preview.11 | 63 | 8/15/2024 |
0.9.1-preview.10 | 64 | 8/15/2024 |
0.9.1-preview.9 | 69 | 8/14/2024 |
0.9.1-preview.8 | 67 | 8/14/2024 |
0.9.1-preview.7 | 39 | 8/5/2024 |
0.9.1-preview.6 | 71 | 7/18/2024 |
0.9.1-preview.5 | 49 | 7/17/2024 |
0.9.1-preview.4 | 59 | 7/16/2024 |
0.9.1-preview.3 | 40 | 7/5/2024 |
0.9.1-preview.2 | 53 | 6/25/2024 |
0.9.1-preview.1 | 53 | 6/14/2024 |
0.9.0 | 14,452 | 6/12/2024 |
0.8.2-preview.4 | 50 | 6/12/2024 |
0.8.2-preview.3 | 53 | 6/10/2024 |
0.8.2-preview.2 | 59 | 5/31/2024 |
0.8.2-preview.1 | 53 | 5/31/2024 |
0.8.1 | 1,528 | 5/24/2024 |
0.8.1-preview.1 | 65 | 5/24/2024 |
0.8.0 | 173 | 5/21/2024 |
0.7.1-preview.4 | 56 | 5/21/2024 |
0.7.1-preview.3 | 52 | 5/21/2024 |
0.7.1-preview.2 | 52 | 5/21/2024 |
0.7.1-preview.1 | 62 | 5/10/2024 |
0.7.0 | 892 | 5/8/2024 |
0.6.1-preview.4 | 63 | 5/8/2024 |
0.6.1-preview.3 | 29 | 5/2/2024 |
0.6.1-preview.2 | 64 | 4/15/2024 |
0.6.1-preview.1 | 66 | 4/12/2024 |
0.6.0 | 1,424 | 4/10/2024 |
0.5.1-preview.3 | 60 | 4/10/2024 |
0.5.1-preview.2 | 62 | 4/3/2024 |
0.5.1-preview.1 | 61 | 4/3/2024 |
0.5.0 | 196 | 4/2/2024 |
0.4.1-preview.1 | 78 | 3/27/2024 |
0.4.0 | 857 | 3/20/2024 |
0.2.2-preview.2 | 55 | 3/20/2024 |
0.2.2-preview.1 | 61 | 3/18/2024 |
0.2.1 | 176 | 3/14/2024 |
0.2.1-preview.9 | 58 | 3/12/2024 |
0.2.1-preview.8 | 58 | 3/11/2024 |
0.2.1-preview.7 | 55 | 3/7/2024 |
0.2.1-preview.6 | 63 | 3/4/2024 |
0.2.1-preview.5 | 72 | 3/1/2024 |
0.2.1-preview.4 | 65 | 2/16/2024 |
0.2.1-preview.3 | 782 | 2/12/2024 |
0.2.1-preview.2 | 74 | 2/6/2024 |
0.2.1-preview.1 | 1,185 | 1/29/2024 |
0.2.0 | 236 | 1/29/2024 |
0.1.1-preview.1 | 60 | 1/29/2024 |
0.1.0 | 121 | 1/26/2024 |
0.1.0-preview.26 | 73 | 1/23/2024 |
0.1.0-preview.25 | 60 | 1/22/2024 |
0.1.0-preview.24 | 70 | 1/15/2024 |
0.1.0-preview.23 | 71 | 1/12/2024 |
0.1.0-preview.22 | 59 | 1/12/2024 |
0.1.0-preview.21 | 66 | 1/12/2024 |
0.1.0-preview.20 | 118 | 12/22/2023 |
0.1.0-preview.19 | 83 | 12/20/2023 |
0.1.0-preview.18 | 82 | 12/18/2023 |
0.1.0-preview.17 | 92 | 12/7/2023 |
0.1.0-preview.16 | 151 | 12/1/2023 |
0.1.0-preview.15 | 84 | 11/30/2023 |
0.1.0-preview.14 | 70 | 11/29/2023 |
0.1.0-preview.13 | 79 | 11/24/2023 |
0.1.0-preview.12 | 82 | 11/17/2023 |
0.1.0-preview.11 | 68 | 11/17/2023 |
0.1.0-preview.10 | 89 | 11/13/2023 |