Name: PublicApiGenerator
Author: Jake Ginnivan

PublicApiGenerator — nugetz

var publicApi = typeof(Library).Assembly.GeneratePublicApi();

var myTypes = new[] { typeof(MyType), typeof(YetAnotherType) };
var publicApi = typeof(myTypes).GeneratePublicApi();

var publicApi = typeof(MyType).GeneratePublicApi();

var options = new ApiGeneratorOptions { ... };
var publicApi = typeof(Library).Assembly.GeneratePublicApi(options);

[Fact]
public void my_assembly_has_no_public_api_changes()
{
    var publicApi = typeof(Library).Assembly.GeneratePublicApi();

    var approvedFilePath = "PublicApi.approved.txt";
    if (!File.Exists(approvedFilePath))
    {
        // Create a file to write to.
        using (var sw = File.CreateText(approvedFilePath)) { }
    }

    var approvedApi = File.ReadAllText(approvedFilePath);

    Assert.Equal(approvedApi, publicApi);
}

[Fact]
public void my_assembly_has_no_public_api_changes()
{
    var publicApi = typeof(Library).Assembly.GeneratePublicApi();

    //Shouldly
    publicApi.ShouldMatchApproved();
}

[Fact]
public void my_assembly_has_no_public_api_changes()
{
    var publicApi = typeof(Library).Assembly.GeneratePublicApi();
    var writer = new ApprovalTextWriter(publicApi, "txt");
    var approvalNamer = new AssemblyPathNamer(assembly.Location);
    Approvals.Verify(writer, approvalNamer, Approvals.GetReporter());
}

private class AssemblyPathNamer : UnitTestFrameworkNamer
{
    private readonly string name;

    public AssemblyPathNamer(string assemblyPath)
    {
        name = Path.GetFileNameWithoutExtension(assemblyPath);
    }

    public override string Name
    {
        get { return name; }
    }
}

[Fact]
public Task my_assembly_has_no_public_api_changes()
{
    var publicApi = typeof(Library).Assembly.GeneratePublicApi();

    return Verifier.Verify(publicApi);

    // Or, if the public api is different based on the target frameworks:
    // return Verifier.Verify(publicApi).UniqueForTargetFrameworkAndVersion();
}

[Test]
public Task my_assembly_has_no_public_api_changes()
{
    var publicApi = typeof(Library).Assembly.GeneratePublicApi();

    return Verifier.Verify(publicApi);
}


[TestClass]
public class VerifyObjectSamples :
    VerifyBase
{
    [TestMethod]
    public Task my_assembly_has_no_public_api_changes()
    {
        var publicApi = typeof(Library).Assembly.GeneratePublicApi();

        return Verifier.Verify(publicApi);
    }
}

dotnet tool install -g PublicApiGenerator.Tool

dotnet tool update -g PublicApiGenerator.Tool

dotnet tool uninstall -g PublicApiGenerator.Tool

generate-public-api --target-frameworks netcoreapp2.1 net461 --package FluentAssertions --package-version 5.6.0

generate-public-api --target-frameworks net47 --package FluentAssertions --package-version 5.*

generate-public-api --target-frameworks net47 --package FluentAssertions --package-version 5.* > api.txt

generate-public-api --target-frameworks net47 --package FluentAssertions --package-version 5.* --output-directory .

generate-public-api --target-frameworks net47 --package FluentAssertions --package-version [5.6.0]

generate-public-api --target-frameworks  netcoreapp2.2 net452 --package NServiceBus --package-version 7.1.4 --assembly NServiceBus.Core.dll

generate-public-api --target-frameworks netcoreapp2.2 net452 --package NServiceBus --package-version 7.1.4 --assembly NServiceBus.Core.dll --package-source https://www.myget.org/F/particular/api/v3/index.json

--target-frameworks framework1 framework2 framework3

--package PackageName

--package-version Version

--package-source Source

--assembly Assembly.dll

--project-path

--working-directory Path

--output-directory Path

--generator-version Version

--verbose

--leave-artifacts

--wait-time-in-seconds

--settings-file

daniel.marbach/PublicApiGeneratorv11.5.4

Get Started

Readme

PublicApiGenerator

How do I use it

Manual

Shouldly

ApprovalTests

Verify

PublicApi Generator Global Tool

Install

Update

Remove

Examples

Command line arguments

Links

Keywords

Maintainers