NAME
SQL::Translator::Parser::OpenAPI - convert OpenAPI schema to SQL::Translator schema
SYNOPSIS
use SQL::Translator;
use SQL::Translator::Parser::OpenAPI;
my $translator = SQL::Translator->new;
$translator->parser("OpenAPI");
$translator->producer("YAML");
$translator->translate($file);
# or...
$ sqlt -f OpenAPI -t MySQL <my-openapi.json >my-mysqlschema.sqlDESCRIPTION
This module implements a SQL::Translator::Parser to convert a JSON::Validator::OpenAPI specification to a SQL::Translator::Schema.
It uses, from the given API spec, the given "definitions" to generate tables in an RDBMS with suitable columns and types.
To try to make the data model represent the "real" data, it applies heuristics:
to remove object definitions that only have one property
to find object definitions that have all the same properties as another, and remove all but the shortest-named one
to remove object definitions whose properties are a strict subset of another
ARGUMENTS
None at present.
PACKAGE FUNCTIONS
parse
Standard as per SQL::Translator::Parser. The input $data is a scalar that can be understood as a JSON::Validator specification.
defs2mask
Given a hashref that is a JSON pointer to an OpenAPI spec's /definitions, returns a hashref that maps each definition name to a bitmask. The bitmask is set from each property name in that definition, according to its order in the complete sorted list of all property names in the definitions. Not exported. E.g.
# properties:
my $defs = {
d1 => {
properties => {
p1 => 'string',
p2 => 'string',
},
},
d2 => {
properties => {
p2 => 'string',
p3 => 'string',
},
},
};
my $mask = SQL::Translator::Parser::OpenAPI::defs2mask($defs);
# all prop names, sorted: qw(p1 p2 p3)
# $mask:
{
d1 => (1 << 0) | (1 << 1),
d2 => (1 << 1) | (1 << 2),
}DEBUGGING
To debug, set environment variable SQLTP_OPENAPI_DEBUG to a true value.
AUTHOR
Ed J, <etj at cpan.org>
LICENSE
Copyright (C) Ed J
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.