ApiDiffChecker 0.1.22

There is a newer version of this package available.
See the version list below for details.

dotnet add package ApiDiffChecker --version 0.1.22

NuGet\Install-Package ApiDiffChecker -Version 0.1.22

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="ApiDiffChecker" Version="0.1.22" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add ApiDiffChecker --version 0.1.22

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: ApiDiffChecker, 0.1.22"

#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 ApiDiffChecker as a Cake Addin
#addin nuget:?package=ApiDiffChecker&version=0.1.22

// Install ApiDiffChecker as a Cake Tool
#tool nuget:?package=ApiDiffChecker&version=0.1.22

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

API Diff Checker

A simple API Testing tool to compare the differences in responses between 2 different origins.

Easily check how your local environment compares to your test server
Verify that any refactoring work did not introduce any accidental changes

Setup

Setup dependency injection

if (builder.Environment.IsDevelopment())
{
    builder.Services.AddApiDiffChecker(
        ApiDiffCheckerSettings.GetSettingsFromJson(
        jsonPath: $"{Environment.CurrentDirectory}/apiDiffChecker.json",
        baseUrl1: "https://localhost:44371",
        baseUrl2: "https://www.my-test-server.com"));
}

Add endpoints used by ApiDiffChecker

if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();

    // ApiDiffChecker Endpoints
    app.AddApiDiffCheckerEndpoints();
}

Add a new profile to launchSettings.json

{
    "ApiDiffChecker": {
        "commandName": "IISExpress",
        "launchBrowser": true,
        "launchUrl": "api-diff-checker",
        "environmentVariables": {
            "ASPNETCORE_ENVIRONMENT": "Development"
        }
    }
}

Powered by

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.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net8.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0)
- Newtonsoft.Json (>= 13.0.1)
- Swashbuckle (>= 5.0.0)
- Swashbuckle.AspNetCore (>= 6.3.0)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.