.NET 帮助

Octokit .NET（开发人员如何使用）

发布 2024年七月1日

在 .NET 项目中设置 Octokit.NET

要开始在您的项目中使用 Octokit.NET，首先需要安装该软件包。您可以通过 NuGet 添加，这是最简单的方法。在 Visual Studio 中，您可以使用 NuGet 包管理器。搜索 Octokit 并将其安装到您的项目中。

基本代码示例：访问 GitHub 用户信息

下面是一个如何使用 Octokit.NET 检索 GitHub 用户信息的简单示例。本示例假定您已经使用 Octokit.NET 设置了您的项目。

using Octokit;
using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        // Create a new instance of the GitHubClient class
        var client = new GitHubClient(new ProductHeaderValue("YourAppName"));
        // Retrieve user information
        var user = await client.User.Get("octocat");
        // Output the user's name
        Console.WriteLine("User Name: " + user.Name);
    }
}

using Octokit;
using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        // Create a new instance of the GitHubClient class
        var client = new GitHubClient(new ProductHeaderValue("YourAppName"));
        // Retrieve user information
        var user = await client.User.Get("octocat");
        // Output the user's name
        Console.WriteLine("User Name: " + user.Name);
    }
}

Imports Octokit
Imports System
Imports System.Threading.Tasks

Friend Class Program
	Shared Async Function Main(ByVal args() As String) As Task
		' Create a new instance of the GitHubClient class
		Dim client = New GitHubClient(New ProductHeaderValue("YourAppName"))
		' Retrieve user information
		Dim user = Await client.User.Get("octocat")
		' Output the user's name
		Console.WriteLine("User Name: " & user.Name)
	End Function
End Class

VB C#

该代码片段创建了一个新的 GitHub 客户端，并根据特定用户 octocat 的版本库名称检索其信息。然后将用户名打印到控制台。它可以使用用户的用户名通过验证访问 GitHub 的 API，也可以不通过验证访问公共仓库。

实现 Octokit.NET 的功能

搜索资源库

您可以使用 Octokit.NET 按条件搜索 GitHub 仓库。以下是如何进行搜索：

using Octokit;
using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var client = new GitHubClient(new ProductHeaderValue("YourAppName"));
        var searchRepositoriesRequest = new SearchRepositoriesRequest("machine learning")
        {
            Language = Language.CSharp
        };
        var result = await client.Search.SearchRepo(searchRepositoriesRequest);
        foreach (var repo in result.Items)
        {
            Console.WriteLine(repo.FullName);
        }
    }
}

using Octokit;
using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var client = new GitHubClient(new ProductHeaderValue("YourAppName"));
        var searchRepositoriesRequest = new SearchRepositoriesRequest("machine learning")
        {
            Language = Language.CSharp
        };
        var result = await client.Search.SearchRepo(searchRepositoriesRequest);
        foreach (var repo in result.Items)
        {
            Console.WriteLine(repo.FullName);
        }
    }
}

Imports Octokit
Imports System
Imports System.Threading.Tasks

Friend Class Program
	Shared Async Function Main(ByVal args() As String) As Task
		Dim client = New GitHubClient(New ProductHeaderValue("YourAppName"))
		Dim searchRepositoriesRequest As New SearchRepositoriesRequest("machine learning") With {.Language = Language.CSharp}
		Dim result = Await client.Search.SearchRepo(searchRepositoriesRequest)
		For Each repo In result.Items
			Console.WriteLine(repo.FullName)
		Next repo
	End Function
End Class

VB C#

该代码搜索用 C# 编写的与 "机器学习 "相关的资源库。它将输出资源库的全名。

管理分叉源

要管理分叉源，您可以列出并创建分叉。以下是如何列出版本库的分叉：

using Octokit;
using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var client = new GitHubClient(new ProductHeaderValue("YourAppName"));
        var forks = await client.Repository.Forks.GetAll("octocat", "Hello-World");
        foreach (var fork in forks)
        {
            Console.WriteLine("Fork ID: " + fork.Id + " - Owner: " + fork.Owner.Login);
        }
    }
}

using Octokit;
using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var client = new GitHubClient(new ProductHeaderValue("YourAppName"));
        var forks = await client.Repository.Forks.GetAll("octocat", "Hello-World");
        foreach (var fork in forks)
        {
            Console.WriteLine("Fork ID: " + fork.Id + " - Owner: " + fork.Owner.Login);
        }
    }
}

Imports Octokit
Imports System
Imports System.Threading.Tasks

Friend Class Program
	Shared Async Function Main(ByVal args() As String) As Task
		Dim client = New GitHubClient(New ProductHeaderValue("YourAppName"))
		Dim forks = Await client.Repository.Forks.GetAll("octocat", "Hello-World")
		For Each fork In forks
			Console.WriteLine("Fork ID: " & fork.Id & " - Owner: " & fork.Owner.Login)
		Next fork
	End Function
End Class

VB C#

此示例列出了 octocat 拥有的 "Hello-World "版本库的所有分叉。

处理率限制

在与 GitHub API 交互时，理解和处理速率限制至关重要。 Octokit.NET提供了检查费率限制的工具：

using Octokit;
using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var client = new GitHubClient(new ProductHeaderValue("YourAppName"));
        var rateLimit = await client.Miscellaneous.GetRateLimits();
        Console.WriteLine("Core Limit: " + rateLimit.Resources.Core.Limit);
    }
}

using Octokit;
using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var client = new GitHubClient(new ProductHeaderValue("YourAppName"));
        var rateLimit = await client.Miscellaneous.GetRateLimits();
        Console.WriteLine("Core Limit: " + rateLimit.Resources.Core.Limit);
    }
}

Imports Octokit
Imports System
Imports System.Threading.Tasks

Friend Class Program
	Shared Async Function Main(ByVal args() As String) As Task
		Dim client = New GitHubClient(New ProductHeaderValue("YourAppName"))
		Dim rateLimit = Await client.Miscellaneous.GetRateLimits()
		Console.WriteLine("Core Limit: " & rateLimit.Resources.Core.Limit)
	End Function
End Class

VB C#

该代码段会检查并显示 GitHub API 使用量的核心限制，帮助你在不超过速率限制的情况下管理请求。

支持反应式扩展

Octokit.NET 支持反应式扩展(Rx)用于反应式编程。这是一个基本的例子：

using Octokit.Reactive;
using System;

var client = new ObservableGitHubClient(new ProductHeaderValue("YourAppName"));
var subscription = client.User.Get("octocat").Subscribe(
    user => Console.WriteLine("User Name: " + user.Name),
    error => Console.WriteLine("Error: " + error.Message)
);
// Unsubscribe when done
subscription.Dispose();

using Octokit.Reactive;
using System;

var client = new ObservableGitHubClient(new ProductHeaderValue("YourAppName"));
var subscription = client.User.Get("octocat").Subscribe(
    user => Console.WriteLine("User Name: " + user.Name),
    error => Console.WriteLine("Error: " + error.Message)
);
// Unsubscribe when done
subscription.Dispose();

Imports Octokit.Reactive
Imports System

Private client = New ObservableGitHubClient(New ProductHeaderValue("YourAppName"))
Private subscription = client.User.Get("octocat").Subscribe(Sub(user) Console.WriteLine("User Name: " & user.Name), Sub([error]) Console.WriteLine("Error: " & [error].Message))
' Unsubscribe when done
subscription.Dispose()

VB C#

本例演示了如何异步检索用户信息并进行反应式处理。

使用标签

要通过 Octokit.NET 使用 Git 标签，您可以从版本库中检索标签：

using Octokit;
using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var client = new GitHubClient(new ProductHeaderValue("YourAppName"));
        var tags = await client.Repository.GetAllTags("octocat", "Hello-World");
        foreach (var tag in tags)
        {
            Console.WriteLine("Tag Name: " + tag.Name);
        }
    }
}

using Octokit;
using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var client = new GitHubClient(new ProductHeaderValue("YourAppName"));
        var tags = await client.Repository.GetAllTags("octocat", "Hello-World");
        foreach (var tag in tags)
        {
            Console.WriteLine("Tag Name: " + tag.Name);
        }
    }
}

Imports Octokit
Imports System
Imports System.Threading.Tasks

Friend Class Program
	Shared Async Function Main(ByVal args() As String) As Task
		Dim client = New GitHubClient(New ProductHeaderValue("YourAppName"))
		Dim tags = Await client.Repository.GetAllTags("octocat", "Hello-World")
		For Each tag In tags
			Console.WriteLine("Tag Name: " & tag.Name)
		Next tag
	End Function
End Class

VB C#

这段代码列出了 octocat 拥有的 "Hello-World "资源库的所有标记。

将 Octokit.NET 与 IronPDF 相集成

Octokit .NET（如何为开发人员工作）：图 1 - IronPDF

IronPDF 是一种流行的 .NET 库，允许开发人员直接在 C# 和 .NET 应用程序中创建、处理和渲染 PDF。这是一款功能强大的工具，可用于从 HTML、发票或任何需要固定版面格式的文档生成 PDF 报告。 Octokit.NET 可与 GitHub 的 API 进行交互，当与 Octokit.NET 结合使用时，文档流程（尤其是涉及代码库的文档流程）的自动化潜力将大大提高。

探索 IronPDF 库

要了解有关 IronPDF 及其功能的更多信息，请访问IronPDF 官方网站. 他们的网站提供全面的资源和文档，为您的开发过程提供支持。

IronPDF 与 Octokit.NET 合并的使用案例

将 IronPDF 与 Octokit.NET 集成的一个实际用例是自动生成存储在 GitHub 存储库中的项目文档的 PDF 报告。例如，您可以从特定资源库中获取所有 markdown 文件，将其转换为 PDF 文档，然后将该文档分发给可能更喜欢文档或发布说明的编译版本的利益相关者或客户。

使用案例的代码示例

让我们创建一个简单的应用程序来演示这种集成。应用程序将执行以下任务：

使用 Octokit.NET 验证并连接到 GitHub。
从指定的存储库中获取文件。
使用 IronPDF 将这些文件从 Markdown 转换为 PDF。
将 PDF 保存到本地计算机。
下面是用 C# 写成的译文：

using Octokit;
using IronPdf;
using System;
using System.Threading.Tasks;
using System.Linq;

class Program
{
    static async Task Main(string[] args)
    {
        // GitHub client setup
        var client = new GitHubClient(new ProductHeaderValue("YourAppName"));
        var tokenAuth = new Credentials("your_github_token"); // Replace with your GitHub token
        client.Credentials = tokenAuth;
        // Repository details
        var owner = "repository_owner";
        var repo = "repository_name";
        // Fetch repository content
        var contents = await client.Repository.Content.GetAllContents(owner, repo);
        // Initialize the PDF builder
        var pdf = new ChromePdfRenderer();
        // Convert each markdown file to PDF
        foreach (var content in contents.Where(c => c.Name.EndsWith(".md")))
        {
            pdf.RenderHtmlAsPdf(content.Content).SaveAs($"{content.Name}.pdf");
            Console.WriteLine($"Created PDF for: {content.Name}");
        }
    }
}

using Octokit;
using IronPdf;
using System;
using System.Threading.Tasks;
using System.Linq;

class Program
{
    static async Task Main(string[] args)
    {
        // GitHub client setup
        var client = new GitHubClient(new ProductHeaderValue("YourAppName"));
        var tokenAuth = new Credentials("your_github_token"); // Replace with your GitHub token
        client.Credentials = tokenAuth;
        // Repository details
        var owner = "repository_owner";
        var repo = "repository_name";
        // Fetch repository content
        var contents = await client.Repository.Content.GetAllContents(owner, repo);
        // Initialize the PDF builder
        var pdf = new ChromePdfRenderer();
        // Convert each markdown file to PDF
        foreach (var content in contents.Where(c => c.Name.EndsWith(".md")))
        {
            pdf.RenderHtmlAsPdf(content.Content).SaveAs($"{content.Name}.pdf");
            Console.WriteLine($"Created PDF for: {content.Name}");
        }
    }
}

Imports Octokit
Imports IronPdf
Imports System
Imports System.Threading.Tasks
Imports System.Linq

Friend Class Program
	Shared Async Function Main(ByVal args() As String) As Task
		' GitHub client setup
		Dim client = New GitHubClient(New ProductHeaderValue("YourAppName"))
		Dim tokenAuth = New Credentials("your_github_token") ' Replace with your GitHub token
		client.Credentials = tokenAuth
		' Repository details
		Dim owner = "repository_owner"
		Dim repo = "repository_name"
		' Fetch repository content
		Dim contents = Await client.Repository.Content.GetAllContents(owner, repo)
		' Initialize the PDF builder
		Dim pdf = New ChromePdfRenderer()
		' Convert each markdown file to PDF
		For Each content In contents.Where(Function(c) c.Name.EndsWith(".md"))
			pdf.RenderHtmlAsPdf(content.Content).SaveAs($"{content.Name}.pdf")
			Console.WriteLine($"Created PDF for: {content.Name}")
		Next content
	End Function
End Class

VB C#

在本例中，在设置好 GitHub 客户端并指定您的证书后，您将从一个版本库中获取内容。对于资源库中的每个 markdown 文件，IronPDF 都会将内容转换为 PDF 文件，然后保存到本地。这个简单而有效的工作流程可以扩展到包括更复杂的过滤、格式化，甚至为更大的资源库批量处理文件。

结论

Octokit .NET（开发人员如何使用）：图 2 - 许可证

将 Octokit.NET 与 IronPDF 集成可提供一种无缝方法，在 GitHub 项目中自动化和简化文档工作流程。利用这些工具，您可以提高处理文档的效率，使文档以满足各种专业需求的格式轻松获取。特别是 IronPDF，它为 PDF 操作提供了一个强大的平台，值得注意的是，他们提供免费试用，让您轻松上手。如果您决定在您的项目中使用该工具，许可费用为 749 美元起。

有关 Iron Software 产品的更多信息，包括 IronPDF 和其他库（如 IronBarcode、IronOCR、IronWebScraper 等），请访问网站Iron Software 产品库.

< 前一页
Mathnet.Numerics C#（它是如何为开发者工作的）

下一步 >
Specflow C#（它如何为开发人员工作）