PublicApiGenerator 使用教程

PublicApiGenerator 使用教程

PublicApiGeneratorProject to generate a public API of an assembly or type (useful for semantic versioning)项目地址:https://gitcode.com/gh_mirrors/pu/PublicApiGenerator

项目介绍

PublicApiGenerator 是一个开源项目，用于生成程序集或类型的公共API。这对于语义版本控制非常有用。该项目支持C# 8的可空引用类型，并且没有外部依赖。

项目快速启动

安装

首先，通过NuGet安装PublicApiGenerator：

dotnet add package PublicApiGenerator --version 9.3.0

使用示例

以下是一个简单的使用示例，生成指定程序集的公共API：

using PublicApiGenerator;
using System;
using System.Reflection;

class Program
{
    static void Main()
    {
        var assembly = Assembly.Load("YourAssemblyName");
        var api = assembly.GeneratePublicApi();
        Console.WriteLine(api);
    }
}

应用案例和最佳实践

应用案例

PublicApiGenerator 可以用于自动化测试，确保库的公共API在不同版本之间保持一致。例如，可以在CI/CD流程中使用它来验证API的兼容性。

最佳实践

1. 版本控制：在发布新版本之前，使用PublicApiGenerator生成并比较API，确保没有意外的API更改。
2. 自动化测试：将API生成集成到自动化测试中，确保每次提交都不会破坏公共API。

典型生态项目

相关项目

1. NServiceBus：一个消息传递框架，可以使用PublicApiGenerator来生成其公共API。
2. FluentAssertions：一个断言库，可以使用PublicApiGenerator来确保其API的稳定性。

通过这些模块的介绍和示例，您可以快速上手并深入了解PublicApiGenerator的使用和最佳实践。

PublicApiGeneratorProject to generate a public API of an assembly or type (useful for semantic versioning)项目地址:https://gitcode.com/gh_mirrors/pu/PublicApiGenerator