Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RehanSaeed/Schema.NET
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.
https://github.com/RehanSaeed/Schema.NET
c-sharp covid-19 dotnet dotnet-core google-structured-data json-ld poco schema schema-org structured-data
Last synced: 7 days ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/RehanSaeed/Schema.NET
- Owner: RehanSaeed
- License: mit
- Created: 2017-06-07T08:16:09.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-04-27T19:40:52.000Z (6 months ago)
- Last Synced: 2024-05-01T13:32:59.089Z (6 months ago)
- Topics: c-sharp, covid-19, dotnet, dotnet-core, google-structured-data, json-ld, poco, schema, schema-org, structured-data
- Language: C#
- Homepage:
- Size: 4 MB
- Stars: 626
- Watchers: 27
- Forks: 80
- Open Issues: 56
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
- jimsghstars - RehanSaeed/Schema.NET - 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 (C# #)
README
[](https://www.nuget.org/packages/Schema.NET) [](https://dev.azure.com/schema-net/Schema.NET/_packaging?_a=package&feed=64e69c35-cb00-46e4-9cba-6d8faf1f41d6&package=fa72270b-6c54-4403-9307-aa826e43530e&preferRelease=true) [](https://www.nuget.org/packages/Schema.NET) [](https://twitter.com/RehanSaeedUK) [](https://twitter.com/RehanSaeedUK)
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
```C#
var website = new WebSite()
{
AlternateName = "An Alternative Name",
Name = "Your Site Name",
Url = new Uri("https://example.com")
};
var jsonLd = website.ToString();
```
The code above outputs the following JSON-LD:
```JSON
{
"@context":"https://schema.org",
"@type":"WebSite",
"alternateName":"An Alternative Name",
"name":"Your Site Name",
"url":"https://example.com"
}
```
If writing the result into a `` element, be sure to use the `.ToHtmlEscapedString()` method instead to avoid exposing your website to a Cross-Site Scripting attack. See the [example below](#important-security-notice).
## What is Schema.org?
[schema.org](https://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](https://developers.google.com/search/docs/guides/intro-structured-data) can display extended metadata about your site in it's search results.
Using structured data in `html` requires the use of a `script` tag with a MIME type of `application/ld+json` like so:
```HTML
<script type="application/ld+json">
{
"@context": "https://schema.org",
"@type": "Organization",
"url": "https://www.example.com",
"name": "Unlimited Ball Bearings Corp.",
"contactPoint": {
"@type": "ContactPoint",
"telephone": "+1-401-555-1212",
"contactType": "Customer service"
}
}
```
##### Important Security Notice
When serializing the result for a website's `` tag, you should use the alternate `.ToHtmlEscapedString()` to avoid exposing yourself to a Cross-Site Scripting (XSS) vulnerability if some of the properties in your schema have been set from untrusted sources.
Usage in an ASP.NET MVC project might look like this:
```HTML
<script type="application/ld+json">
@Html.Raw(Model.Schema.ToHtmlEscapedString())
```
#### Windows UWP Sharing
Windows UWP apps let you share data using schema.org classes. [Here](https://docs.microsoft.com/en-us/uwp/schemas/appxpackage/appxmanifestschema/element-sharetarget) 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:
```C#
// Single string address
var organization = new Organization()
{
Address = "123 Old Kent Road E10 6RL"
};
// Multiple string addresses
var organization = new Organization()
{
Address = new List()
{
"123 Old Kent Road E10 6RL",
"456 Finsbury Park Road SW1 2JS"
}
};
// Single PostalAddress address
var organization = new Organization()
{
Address = new PostalAddress()
{
StreetAddress = "123 Old Kent Road",
PostalCode = "E10 6RL"
}
};
// Multiple PostalAddress addresses
var organization = new Organization()
{
Address = new List()
{
new PostalAddress()
{
StreetAddress = "123 Old Kent Road",
PostalCode = "E10 6RL"
},
new PostalAddress()
{
StreetAddress = "456 Finsbury Park Road",
PostalCode = "SW1 2JS"
}
}
};
// Mixed Author types
var book = new Book()
{
Author = new List()
{
new Organization() { Name = "Penguin" },
new Person() { Name = "J.D. Salinger" }
}
};
// Deconstruct a property containing mixed types
if (book.Author.HasValue)
{
var (organisations, people) = book.Author.Value;
}
```
This magic is all carried out using [implicit conversion operators](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/implicit) in the `OneOrMany`, `Values`, `Values` and `Values` types. These types are all `structs` for best performance too.
## More Examples
For more examples and actual running code samples, take a look at the unit tests in the project source code.
## Schema.NET.Pending
There are many pending types on [schema.org](https://schema.org) which are not yet fully formed and ready for production. If you need to use these, you can install the [Schema.NET.Pending](https://www.nuget.org/packages/Schema.NET.Pending) NuGet package instead of [Schema.NET](https://www.nuget.org/packages/Schema.NET). This package contains all released schema types as well as all pending types.
[](https://www.nuget.org/packages/Schema.NET.Pending) [](https://dev.azure.com/schema-net/Schema.NET/_packaging?_a=package&feed=64e69c35-cb00-46e4-9cba-6d8faf1f41d6&package=3f7ed124-c136-4be6-8972-3a6b612b932e&preferRelease=true) [](https://www.nuget.org/packages/Schema.NET.Pending)
## Continuous Integration
| Name | Operating System | Status | History |
| :--- | :--- | :--- | :--- |
| Azure Pipelines | Ubuntu | [](https://dev.azure.com/schema-net/Schema.NET/_build/latest?definitionId=1&branchName=main) |
| Azure Pipelines | Mac | [](https://dev.azure.com/schema-net/Schema.NET/_build/latest?definitionId=1&branchName=main) |
| Azure Pipelines | Windows | [](https://dev.azure.com/schema-net/Schema.NET/_build/latest?definitionId=1&branchName=main) |
| Azure Pipelines | Overall | [](https://dev.azure.com/schema-net/Schema.NET/_build/latest?definitionId=1&branchName=main) | [](https://dev.azure.com/schema-net/Schema.NET/_build/latest?definitionId=1&branchName=main) |
| GitHub Actions | Ubuntu, Mac & Windows | [](https://github.com/RehanSaeed/Schema.NET/actions) | [](https://github.com/RehanSaeed/Schema.NET/actions) |
| AppVeyor | Ubuntu, Mac & Windows | [](https://ci.appveyor.com/project/RehanSaeed/schema-net/branch/main) | [](https://ci.appveyor.com/project/RehanSaeed/schema-net) |
## Contributions and Thanks
Please view the [contributing guide](https://github.com/RehanSaeed/Schema.NET/blob/main/.github/CONTRIBUTING.md) for more information.
- [kirkone](https://github.com/kirkone) - CI reads .NET Core version from new global.json file.
- [Turnerj](https://github.com/Turnerj) - Added `System.Text.Json` support, Had all types implement `IEquatable` `GetHashCode` and added extra unit tests and bug fixes.
- [shervinw](https://github.com/shervinw) - Added better null value handling for structs.
- [kirk-marple](https://github.com/kirk-marple) - Refactoring JSON serialization to be more efficient.
- [nickevansuk](https://github.com/nickevansuk) - Adding better null value handling and use HTTPS instead of HTTP.
- [MEmanuelsson](https://github.com/MEmanuelsson) - Added support for the schema.org Date type without time.
- [halovanic](https://github.com/halovanic) - For adding interfaces to Schema.NET types for greater flexibility.
- [AndreSteenbergen](https://github.com/AndreSteenbergen) - For enabling the tool to work on linux.
- [benmccallum](https://github.com/benmccallum) - For adding XSS vlnerability protection.
- [psampaio](https://github.com/psampaio) - Added deserialization support and unit tests.
- [icunningham88](https://github.com/icunningham88) - Improved a test.