documentation generator & other tools for protobuf/gRPC
Branch: master
Clone or download
slimsag Merge pull request #14 from gm42/patch-1
Colon is not a supported character in values
Latest commit b54ce59 Jan 5, 2017

README.md

prototools

This repository holds various Protobuf/gRPC tools:

protoc-gen-doc

protoc-gen-doc is a Protobuf compiler plugin for generating HTML documentation from .proto files using standard Go HTML template files.

protoc-gen-json

protoc-gen-json is a Protobuf compiler plugin for generating a JSON dump file for the protoc plugin generation request. It is primarily useful for running tests without invoking protoc directly (e.g. via the Go testing suite).

protoc-gen-dump

protoc-gen-dump is just like protoc-gen-json except it dumps output in protobuf format itself. It's much better than protoc-gen-json if you can make use of it because there are certain fields (e.g. extensions) which are explicitly marked as non-JSON-encodable. If you wish to retain e.g. grpc-gateway google.api.http annotations, you'll need to make use of protoc-gen-dump instead of protoc-gen-json.