Discover Packages
github.com/xliiauo/protoc-gen-jsonschema
command
module
Version:
v0.0.5
Opens a new window with list of versions in this module.
Published: Jan 24, 2020
License: Apache-2.0
Opens a new window with license information.
Imports: 14
Opens a new window with list of imports.
Imported by: 0
Opens a new window with list of known importers.
README
README
¶
Protobuf to JSON-Schema compiler
This takes protobuf definitions and converts them into JSONSchemas, which can be used to dynamically validate JSON messages.
This will hopefully be useful for people who define their data using ProtoBuf, but use JSON for the "wire" format.
"Heavily influenced" by Google's protobuf-to-BigQuery-schema compiler .
Links
Usage
Allow NULL values (by default, JSONSchemas will reject NULL values unless we explicitly allow them):
protoc --jsonschema_out=allow_null_values:. --proto_path=testdata/proto testdata/proto/ArrayOfPrimitives.proto
Disallow additional properties (JSONSchemas won't validate JSON containing extra parameters):
protoc --jsonschema_out=disallow_additional_properties:. --proto_path=testdata/proto testdata/proto/ArrayOfPrimitives.proto
Disallow permissive validation of big-integers as strings (eg scientific notation):
protoc --jsonschema_out=disallow_bigints_as_strings:. --proto_path=testdata/proto testdata/proto/ArrayOfPrimitives.proto
Enable debug logging:
protoc --jsonschema_out=debug:. --proto_path=testdata/proto testdata/proto/ArrayOfPrimitives.proto
Sample protos (for testing)
Expand ▾
Collapse ▴
Documentation
¶
protoc plugin which converts .proto to JSON schema
It is spawned by protoc and generates JSON-schema files.
"Heavily influenced" by Google's "protog-gen-bq-schema"
usage:
$ bin/protoc --jsonschema_out=path/to/outdir foo.proto
Source Files
¶
Click to show internal directories.
Click to hide internal directories.