Skip to content

oddbit/flutter-schema-org

Repository files navigation

JSON-LD Dart classes for Schema.org vocabulary.

Features

schema_org provides Dart definitions for Schema.org vocabulary that can be exported to JSON-LD format. The typings are exposed as complete sets of discriminated type unions, allowing for easy completions and stricter validation.

You can find all available schemas on Schema.org and each schema is represented in this library with the prefix Schema

For example

Usage

Call the SchemaOrg.writeJsonLd() method and pass it a Schema.org class that represents your data.

SchemaOrg.writeJsonLd(
    SchemaOrganization(
        name: 'Oddbit',
        url: 'https://oddbit.id',
        logo: 'https://avatars.githubusercontent.com/u/1946799?s=200&v=4',
    ),
);

Oddbit Organization Screenshot

Getting involved

First of all, thank you for even considering to get involved. You are a real super ⭐ and we ❤️ you!

All the schema definitions are auto generated by the schema_parser CLI script that you can find in the repository folder /parser.

Reporting bugs and issues

Validating all the schemas and possible quirks of how to interpret their usage is a huge task and we appreciate any findings and links to sources or best practices that can help us to improve this package.

We're grateful for any help that you can provide, and even better if you can provide suggestions for how to improve the schema_parser script that generates all the code.