createSchema static method
JsonSchema
createSchema(
- dynamic schema, {
- SchemaVersion? schemaVersion,
- Uri? fetchedFromUri,
- RefProvider? refProvider,
Create a schema from JSON data
.
This method is synchronous, and doesn't support fetching of remote references, properties, and sub-properties of the schema. If you need remote reference support use createSchemaAsync.
The schema
can either be a decoded JSON object (Only Map or bool per the spec),
or alternatively, a String may be passed in and JSON decoding will be handled automatically.
Implementation
static JsonSchema createSchema(
dynamic schema, {
SchemaVersion? schemaVersion,
Uri? fetchedFromUri,
RefProvider? refProvider,
}) {
// Default to assuming the schema is already a decoded, primitive dart object.
dynamic data = schema;
/// JSON Schemas must be [bool]s or [Map]s, so if we encounter a [String], we're looking at encoded JSON.
/// https://json-schema.org/latest/json-schema-core.html#rfc.section.4.3.1
if (schema is String) {
try {
data = yaon.parse(schema);
} catch (e) {
throw ArgumentError(
'String data provided to createSchema is not valid JSON.');
}
}
/// Set the Schema version before doing anything else, since almost everything depends on it.
final version = _getSchemaVersion(schemaVersion, data);
if (data is Map) {
return JsonSchema._fromRootMap(
Map<String, dynamic>.from(data), schemaVersion,
fetchedFromUri: fetchedFromUri,
isSync: true,
refProvider: refProvider)
.resolvePath('#');
// Boolean schemas are only supported in draft 6 and later.
} else if (data is bool && version == SchemaVersion.draft6) {
return JsonSchema._fromRootBool(data, schemaVersion,
fetchedFromUri: fetchedFromUri,
isSync: true,
refProvider: refProvider)
.resolvePath('#');
}
throw ArgumentError(
'Data provided to createSchemaAsync is not valid: Data must be, or parse to a Map (or bool in draft6 or later). | $data');
}