首页
/ OpenGraphNet 技术文档

OpenGraphNet 技术文档

2024-12-24 20:35:56作者:殷蕙予

1. 安装指南

OpenGraphNet 是一个用于解析 Open Graph 信息的 .NET 程序集。您可以通过以下方式安装:

  • NuGet 包管理器

在 Visual Studio 中,打开 NuGet 包管理器并搜索 OpenGraph-Net。选择相应版本进行安装。

  • 命令行

在项目目录下打开命令行窗口,使用以下命令安装:

Install-Package OpenGraph-Net

2. 项目使用说明

OpenGraphNet 提供了两种基本操作:从 URL 解析和访问元数据。

从 URL 解析

使用 async/await 异步解析 URL:

OpenGraph graph = await OpenGraph.ParseUrlAsync("https://example.com");

访问元数据

每个元数据元素都存储为数组。此外,每个元素的属性也存储为数组。

例如,对于以下 HTML:

<meta property="og:image" content="http://example.com/img1.png">
<meta property="og:image:width" content="30">
<meta property="og:image" content="http://example.com/img2.png">
<meta property="og:image:width" content="60">
<meta property="og:locale" content="zh">
<meta property="og:locale:alternate" content="zh_CN">
<meta property="og:locale:alternate" content="zh_HK">

您可以这样访问值:

graph.Metadata["og:image"].First().Value; // "http://example.com/img1.png"
graph.Metadata["og:image"].First().Properties["width"].Value(); // "30"
graph.Metadata["og:image"][1].Value; // "http://example.com/img2.png"
graph.Metadata["og:image"][1].Properties["width"].Value(); // "60"
graph.Metadata["og:locale"].Value(); // "zh"
graph.Metadata["og:locale"].First().Properties["alternate"][0].Value; // "zh_CN"
graph.Metadata["og:locale"].First().Properties["alternate"][1].Value; // "zh_HK"

3. 项目 API 使用文档

以下是一些主要的 API 方法:

  • OpenGraph.ParseUrlAsync(string url): 异步解析给定 URL 的 Open Graph 信息。
  • OpenGraph.MakeGraph(...): 在内存中创建 Open Graph 数据。
  • graph.ToString(): 将 Open Graph 数据转换为 HTML 格式。

更多 API 方法请参考项目源代码和文档。

4. 项目安装方式

如前所述,您可以通过 NuGet 包管理器或命令行安装 OpenGraphNet。

在 Visual Studio 中,您可以:

  • 使用 NuGet 包管理器界面搜索并安装 OpenGraph-Net 包。
  • 或者在包管理器控制台中运行以下命令:
Install-Package OpenGraph-Net

这将自动将 OpenGraphNet 添加到您的项目中,并准备好使用。

登录后查看全文
热门项目推荐