devongovett / protobuf-jsonschema Goto Github PK

View Code? Open in Web Editor NEW

118.0 5.0 37.0 7 KB

Compiles Protobuf IDL to JSON Schema

JavaScript 100.00%

protobuf-jsonschema's Introduction

protobuf-jsonschema

Compiles Protocol Buffer IDL to JSON Schema definitions.

Usage

You can use protobuf-jsonschema as a command line tool, or as a function in node.

The CLI can output JSON or YAML (e.g. for Swagger). If you specify a protobuf message name along with a file, it will output just that message and all dependencies. Otherwise, it will output all messages.

$ npm install protobuf-jsonschema -g
$ protobuf-jsonschema --help

  Usage: protobuf-jsonschema [options] <file> [model]

  Options:

    -h, --help             output usage information
    -V, --version          output the version number
    -f, --format [format]  output format: json or yaml [json]

In node, protobuf-jsonschema exports a single function that returns an object with the JSON Schema model.

var compile = require('protobuf-jsonschema');

var all = compile('models.proto');
var single = compile('models.proto', 'MyModel');

License

MIT

protobuf-jsonschema's People

Contributors

Stargazers

Watchers

protobuf-jsonschema's Issues

64 bit proto field should be JSON string type, and not integer

According to the Proto3 JSON spec, 64 bit numbers should be treated as string to avoid data loss.

https://developers.google.com/protocol-buffers/docs/proto3#json

proto3 syntax not supported

hello team i tried your library for proto3 syntax but it seems like not supoorted ,(look parser.js line 355 there is no check for syntax).

Problem converting messages with recursive type references.

I am using the version 1.1.1 of the protobuf-jsonschema and I try to convert the following proto file:

syntax = "proto3";

message Directory {
	string name = 1;
	repeated Directory sub_directories = 2;
	repeated File files = 3;
}

message File {
	string name = 1;
}

The result of the execution is the following

/home/.../lib/node_modules/protobuf-jsonschema/index.js:85
    var id = lookup.slice(0, i).concat(type).join('.');
                                             ^

RangeError: Maximum call stack size exceeded
    at Array.join (native)
    at Compiler.resolve (/home/.../lib/node_modules/protobuf-jsonschema/index.js:85:46)
    at Compiler.build (/home/.../lib/node_modules/protobuf-jsonschema/index.js:128:18)
    at Compiler.<anonymous> (/home/.../lib/node_modules/protobuf-jsonschema/index.js:175:14)
    at Array.forEach (<anonymous>)
    at Compiler.compileMessage (/home/.../lib/node_modules/protobuf-jsonschema/index.js:157:18)
    at Compiler.resolve (/home/.../lib/node_modules/protobuf-jsonschema/index.js:101:18)
    at Compiler.build (/home/.../lib/node_modules/protobuf-jsonschema/index.js:128:18)
    at Compiler.<anonymous> (/home/.../lib/node_modules/protobuf-jsonschema/index.js:175:14)
    at Array.forEach (<anonymous>)

I am using the node module on

Linux x86_64 16.04
node v8.11.4
npm 5.6.0

Any chance for transferring proto comments directly above a field to `"$comment"` keyword inside the json type?

i.e. PROTO:

message TIMESTAMP {
        // Represents seconds of UTC time since Unix epoch
        required int64 seconds = 1;   

        // Non-negative fractions of a second at millisecond resolution
        required int32 millis = 2;        
}

JSON SCHEMA:

"TIMESTAMP": {
      "title": "TIMESTAMP",
      "type": "object",
      "properties": {
        "seconds": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991,
          "$comment" : "Represents seconds of UTC time since Unix epoch"
        },
        "millis": {
          "type": "integer",
          "minimum": -2147483648,
          "maximum": 2147483647,
          "$comment" : "Non-negative fractions of a second at millisecond resolution",
        }
      },
      "required": [
        "seconds",
        "millis"
      ]
    }

      start:
        type: integer
        minimum: -9007199254740991
        maximum: 9007199254740991

Similar output occurs for int32. These should be omitted.