OpenGraph-Net
4.0.2-alpha.0.6
dotnet add package OpenGraph-Net --version 4.0.2-alpha.0.6
NuGet\Install-Package OpenGraph-Net -Version 4.0.2-alpha.0.6
<PackageReference Include="OpenGraph-Net" Version="4.0.2-alpha.0.6" />
paket add OpenGraph-Net --version 4.0.2-alpha.0.6
#r "nuget: OpenGraph-Net, 4.0.2-alpha.0.6"
// Install OpenGraph-Net as a Cake Addin #addin nuget:?package=OpenGraph-Net&version=4.0.2-alpha.0.6&prerelease // Install OpenGraph-Net as a Cake Tool #tool nuget:?package=OpenGraph-Net&version=4.0.2-alpha.0.6&prerelease
OpenGraphNet
A simple .net assembly to use to parse Open Graph information from either a URL or an HTML snippet. You can read more about the Open Graph protocol @ http://ogp.me.
Support the library
If you find this library useful, buy me a coffee!
Usage
These are the basic operations of the OpenGraphNet parser.
Parsing from a URL
Use async/await
to parse a URL:
OpenGraph graph = await OpenGraph.ParseUrlAsync("https://open.spotify.com/user/er811nzvdw2cy2qgkrlei9sqe/playlist/2lzTTRqhYS6AkHPIvdX9u3?si=KcZxfwiIR7OBPCzj20utaQ");
Accessing Values
Accessing Metadata
Each metadata element is stored as an array. Additionally, each element's properties are also stored as an array.
<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="en">
<meta property="og:locale:alternate" content="en_US">
<meta property="og:locale:alternate" content="en_GB">
You would access the values from the sample HTML above as:
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(); // "30"
graph.Metadata["og:locale"].Value(); // "en"
graph.Metadata["og:locale"].First().Properties["alternate"][0].Value; // "en_US"
graph.Metadata["og:locale"].First().Properties["alternate"][1].Value; // "en_GB"
Basic Metadata
The four required Open Graph properties for all pages are available as direct properties on the OpenGraph object.
graph.Type
is a shortcut forgraph.Metadata["og:type"].Value()
graph.Title
is a shortcut forgraph.Metadata["og:title"].Value()
graph.Image
is a shortcut forgraph.Metadata["og:image"].Value()
- Note: since there can be multiple images, this helper returns the URI of the
first image. If you want to access images or child properties like
og:image:width
then you should instead use thegraph.Metadata
dictionary.* graph.Url
is a shortcut forgraph.Metadata["og:url"].Value()
Misc
The original URL used to generate the OpenGraph data is available from the OriginalUrl
property
graph.OriginalUrl
.
Creating OpenGraph Data
To create OpenGraph data in memory use the following code:
var graph = OpenGraph.MakeGraph(
title: "My Title",
type: "website",
image: "http://example.com/img/img1.png",
url: "http://example.com/home",
description: "My Description",
siteName: "Example.com");
graph.AddMetadata("og", "image", "http://example.com/img/img2.png");
graph.Metadata["og:image"][0].AddProperty("width", "30");
graph.Metadata["og:image"][1].AddProperty("width", "60");
System.Console.Write(graph.ToString());
The previous System.Console.Write(graph.ToString());
will produce the following HTML (formatting added for legibility):
<meta property="og:title" content="My Title">
<meta property="og:type" content="website">
<meta property="og:image" content="http://example.com/img/img1.png">
<meta property="og:image:width" content="30">
<meta property="og:image" content="http://example.com/img/img2.png">
<meta property="og:image:width" content="60">
<meta property="og:url" content="http://example.com/home">
<meta property="og:description" content="My Description">
<meta property="og:site_name" content="Example.com">
Parsing Namespaces
The component now knows about the 13 namespaces listed below. When parsing a url or a HTML
document, OpenGraph.Net will now read and use those namespaces from either the <html>
or
<head>
tags. The parser is now smart enough to include the namespaces when none are
included in those tags by extracting it from the meta[property]
value directly.
- og: http://ogp.me/ns#
- Expected fields when validating:
title
,type
,image
,url
- Expected fields when validating:
- article: http://ogp.me/ns/article#
- book: http://ogp.me/ns/book#
- books: http://ogp.me/ns/books#
- business http://ogp.me/ns/business#
- fitness: http://ogp.me/ns/fitness#
- game: http://ogp.me/ns/game#
- music: http://ogp.me/ns/music#
- place: http://ogp.me/ns/place#
- product: http://ogp.me/ns/product#
- profile: http://ogp.me/ns/profile#
- restaurant: http://ogp.me/ns/restaurant#
- video: http://ogp.me/ns/video#"
If there are any additional standard/supported namespaces that I am missing, please shoot me a comment or a pull request with the missing items.
Adding Custom Namespaces
You can now add custom namespaces to the parser. Simply make the following call:
NamespaceRegistry.Instance.AddNamespace(
prefix: "gah",
schemaUri: "http://wwww.geoffhorsey.com/ogp/brain#",
requiredElements: new[] { "brain" });
Doing the above will allow the parser to understand the following HTML snippet:
<meta property="gah:brain" content="http://www.geoffhorsey.com/my-brain">
<meta property="gah:brain:size" content="tiny">
and the graph:
graph.Metadata["gah:brain"].Value() // "http://www.geoffhorsey.com/my-brain"
graph.Metadata["gah:brain"].First().Properties["size"].Value() // "tiny"
Writing out OpenGraph Namespaces
In the wild web sites seem to add their OpenGraph namespaces in one of 2 ways. They either
write the namespaces in the html
as xmlns
attributes or within the head
tag in the prefix
attribute.
<html xmlns:og="http://ogp.me/ns#" xmlns:product="http://ogp.me/ns/product#">
<head prefix="og: http://ogp.me/ns# product: http://ogp.me/ns/product#">
xmlns:
version in the html
tag
To create the html
version in an cshtml page after creating a new graph
, use the following code:
<html @graph.HtmlXmlnsValues>
Would produce the following:
<html xmlns:og="http://ogp.me/ns#" xmlns:product="http://ogp.me/ns/product#">
prefix
version in the <head>
tag
To create the head
version in a cshtml page, after create a new graph
, use the following code:
<head prefix="@graph.HeadPrefixAttributeValue">
Would produce the following:
<head prefix="og: http://ogp.me/ns# product: http://ogp.me/ns/product#">
Writing out OpenGraph Metadata to the head
tag
Below is a complete example to write out a OpenGraph metadata to a page:
@{
var graph = OpenGraph.MakeGraph(
title: "My Title",
type: "website",
image: "http://example.com/img/img1.png",
url: "http://example.com/home",
description: "My Description",
siteName: "Example.com");
}
<html>
<head prefix="@graph.HeadPrefixAttributeValue">
@graph.ToString()
</head>
<body>
</body>
</html>
will produce the following HTML:
<html>
<head prefix="og: http://ogp.me/ns#">
<meta property="og:title" content="My Title">
<meta property="og:type" content="website">
<meta property="og:image" content="http://example.com/img/img1.png">
<meta property="og:url" content="http://example.com/home">
<meta property="og:description" content="My Description">
<meta property="og:site_name" content="Example.com">
</head>
<body>
</body>
</html>
It's FOSS
So please don't be afraid to fork me.
Contribution Guide
- Fork the OpenGraph-Net repository
- Create a feature branch for the item you are going to add.
- Add your awesome code and your unit tests to cover the new feature
- Run all of the tests to ensure everything is still passing.
- Create a pull request to our
develop
branch.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. 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. |
.NET Core | netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.1 is compatible. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.1
- HtmlAgilityPack (>= 1.11.46)
- System.Text.Encoding.CodePages (>= 7.0.0)
-
net6.0
- HtmlAgilityPack (>= 1.11.46)
- System.Text.Encoding.CodePages (>= 7.0.0)
NuGet packages (4)
Showing the top 4 NuGet packages that depend on OpenGraph-Net:
Package | Downloads |
---|---|
RestCms.Api.NETCore
This is the main REST CMS API package. This package contains initialization code, controllers, filters and core middleware required to run the REST CMS client API. |
|
Zen.Web.App
WebApp-related abstration layer for Zen |
|
Wechaty
dotnet wechaty |
|
ImageWizard.OpenGraph
Image processing middleware based on ASP.NET and ImageSharp / SkiaSharp / SvgNet. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
4.0.2-alpha.0.6 | 3,870 | 11/14/2022 |
4.0.1 | 184,699 | 8/12/2022 |
4.0.1-alpha.0.3 | 110 | 8/12/2022 |
4.0.1-alpha.0.2 | 115 | 8/12/2022 |
4.0.1-alpha.0.1 | 112 | 8/12/2022 |
4.0.0 | 4,000 | 8/12/2022 |
3.2.9-alpha.0.21 | 109 | 8/12/2022 |
3.2.9-alpha.0.20 | 104 | 8/12/2022 |
3.2.9-alpha.0.16 | 108 | 8/12/2022 |
3.2.9-alpha.0.15 | 113 | 8/12/2022 |
3.2.9-alpha.0.14 | 114 | 8/12/2022 |
3.2.9-alpha.0.10 | 106 | 8/12/2022 |
3.2.9-alpha.0.4 | 879 | 7/27/2021 |
3.2.9-alpha.0.3 | 209 | 7/27/2021 |
3.2.9-alpha.0.2 | 224 | 7/27/2021 |
3.2.8 | 157,689 | 7/27/2021 |
3.2.7 | 4,272 | 6/8/2021 |
3.2.7-alpha.0.40 | 154 | 6/8/2021 |
3.2.7-alpha.0.39 | 151 | 6/8/2021 |
3.2.7-alpha.0.38 | 160 | 6/8/2021 |
3.2.7-alpha.0.37 | 153 | 6/8/2021 |
3.2.7-alpha.0.35 | 163 | 6/8/2021 |
3.2.7-alpha.0.34 | 159 | 6/8/2021 |
3.2.6 | 32,423 | 1/28/2021 |
3.2.5 | 430 | 1/28/2021 |
3.2.4 | 69,006 | 3/24/2020 |
3.2.3 | 2,224 | 2/26/2020 |
3.2.2 | 572 | 2/26/2020 |
3.2.1 | 15,950 | 2/7/2020 |
3.2.0 | 14,498 | 6/15/2019 |
3.1.2 | 41,698 | 3/16/2019 |
3.1.1 | 874 | 2/28/2019 |
3.1.0 | 2,070 | 1/18/2019 |
3.0.0 | 13,777 | 12/5/2018 |
2.2.0 | 36,059 | 5/10/2018 |
2.0.0 | 1,313 | 5/2/2018 |
1.3.4 | 63,329 | 8/17/2016 |
1.3.3 | 1,203 | 8/16/2016 |
1.3.2 | 1,279 | 8/15/2016 |
1.3.1 | 1,262 | 8/15/2016 |
1.3.0.1 | 6,755 | 6/30/2016 |
1.2.0.1 | 8,304 | 4/2/2013 |
Added back NetStandard 2.1.