ProtoTest.OpenApi 1.0.1

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package ProtoTest.OpenApi --version 1.0.1
                    


                    

                
NuGet\Install-Package ProtoTest.OpenApi -Version 1.0.1
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="ProtoTest.OpenApi" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="ProtoTest.OpenApi" Version="1.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="ProtoTest.OpenApi" />
                    


                            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 ProtoTest.OpenApi --version 1.0.1
                    


                    

                
#r "nuget: ProtoTest.OpenApi, 1.0.1"
#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 ProtoTest.OpenApi@1.0.1
#: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=ProtoTest.OpenApi&version=1.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=ProtoTest.OpenApi&version=1.0.1
                    


                            Install as a Cake Tool

ProtoTest.OpenApi

Maps ProtoTest REST observations to an OpenAPI contract and reports endpoint, response and response-property coverage.

dotnet add package ProtoTest.OpenApi

Quick start

builder
    .ConfigureAppConfiguration(configuration => configuration.AddInMemoryCollection(
        new Dictionary<string, string?>
        {
            ["ProtoTest:Applications:Orders:OpenApi:Specification"] =
                Path.Combine(AppContext.BaseDirectory, "orders.openapi.json")
        }))
    .AddApplication("Orders", app => app.AddRest(rest => rest
        .AddClient("Orders")
        .AddCollector<OpenApiCoverageCollector>()));

What it adds

  • Collector — OpenApiCoverageCollector registers on a REST target with AddCollector<OpenApiCoverageCollector>(); a repeat for the same target is a no-op.
  • Sources — the configuration key ProtoTest:Applications:{application}:OpenApi:Specification, a source string (file, inline JSON/YAML or URL), or a prebuilt OpenApiDocument; a required BaseUrl resolves relative specification URLs.
  • Coverage items — endpoints ("OpenAPI", {METHOD} {path}), responses ("OpenAPI Response", exact status, 4XX wildcard or default) and body properties ("OpenAPI Property") consumed from RestResponseData and RestShapeMatchData.
  • Report integration — items are coverage report entries; add ProtoTest.Reporting to export them.

Configuration

Key Type Default
ProtoTest:Applications:{application}:OpenApi:Specification string required by the configuration constructor
ProtoTest:Applications:{application}:BaseUrl string unset; only needed to resolve a relative specification URL
ProtoTest:Applications:{scope}:Application string the target name

The collector reports coverage, never validation: a route outside the specification is ignored, a property counts only when a shape assertion matched it, and there are no trace operations of its own — it reads REST observations.

Learn more

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 is compatible.  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 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.

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.0.1 80 9/20/2026
1.0.0 85 9/20/2026