Skip to content

Repository files navigation

Schema.NET Banner

Schema.org objects turned into strongly typed C# POCO classes for use in .NET. All classes can be serialized into JSON/JSON-LD and XML, typically used to represent structured data in the head section of html page.

Simple Example

varwebsite=newWebSite(){AlternateName="An Alternative Name",Name="Your Site Name",Url=newUri("https://example.com")};varjsonLd=website.ToString();

The code above outputs the following JSON-LD:

{"@context":"http://schema.org","@type":"WebSite","alternateName":"An Alternative Name","name":"Your Site Name","url":"https://example.com"}

What is Schema.org?

schema.org defines a set of standard classes and their properties for objects and services in the real world. This machine readable format is a common standard used across the web for describing things.

Where is Schema.org Used?

Websites

Websites can define Structured Data in the head section of their html to enable search engines to show richer information in their search results. Here is an example of how Google can display extended metadata about your site in it's search results.

Google Logo Structured Data Example

Using structured data in html requires the use of a script tag with a MIME type of application/ld+json like so:

<scripttype="application/ld+json">{"@context": "http://schema.org","@type": "Organization","url": "http://www.example.com","name": "Unlimited Ball Bearings Corp.","contactPoint": {"@type": "ContactPoint","telephone": "+1-401-555-1212","contactType": "Customer service"}}</script>

Windows UWP Sharing

Windows UWP apps let you share data using schema.org classes. Here is an example showing how to share metadata about a book.

Classes & Properties

schema.org defines classes and properties, where each property can have a single value or an array of multiple values. Additionally, properties can have multiple types e.g. an Address property could have a type of string or a type of PostalAddress which has it's own properties such as StreetAddress or PostalCode which breaks up an address into it's constituent parts.

To facilitate this Schema.NET uses some clever C# generics and implicit type conversions so that setting a single or multiple values is possible and that setting a string or PostalAddress is also possible:

// Single string addressvarorganization=newOrganization(){Address="123 Old Kent Road E10 6RL"};// Multiple string addressesvarorganization=newOrganization(){Address=newList<string>(){"123 Old Kent Road E10 6RL","456 Finsbury Park Road SW1 2JS"}};// Single PostalAddress addressvarorganization=newOrganization(){Address=newPostalAddress(){StreetAddress="123 Old Kent Road",PostalCode="E10 6RL"}};// Multiple PostalAddress addressesvarorganization=newOrganization(){Address=newList<PostalAddress>(){newPostalAddress(){StreetAddress="123 Old Kent Road",PostalCode="E10 6RL"},newPostalAddress(){StreetAddress="456 Finsbury Park Road",PostalCode="SW1 2JS"}}};

This magic is all carried out using the Value<T>, Value<T1, T2>, Value<T1, T2, T3> etc. types. These types are all structs for best performance too.

Continuous Integration

NameOperating SystemStatus
AppVeyorWindowsAppVeyor Build status
Travis CILinux & MacTravis CI Build Status

NuGet Packages

NameNuGetMyGet
Schema.NETSchema.NET NuGet PackageSchema.NET MyGet Package

Contributions and Thanks

  • psampaio - Added deserialization support and unit tests.

About

Schema.org objects turned into strongly typed C# POCO classes for use in .NET. All classes can be serialized into JSON/JSON-LD and XML, typically used to represent structured data in the head section of html page.

Resources

Contributing

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages