README
¶
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.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
protoc-gen-doc
Command protoc-gen-doc is a Protobuf plugin for documentation generation.
|
Command protoc-gen-doc is a Protobuf plugin for documentation generation. |
|
protoc-gen-dump
Command protoc-gen-dump is a Protobuf plugin for generating proto dump files.
|
Command protoc-gen-dump is a Protobuf plugin for generating proto dump files. |
|
protoc-gen-json
Command protoc-gen-doc is a Protobuf plugin for generating JSON dump files.
|
Command protoc-gen-doc is a Protobuf plugin for generating JSON dump files. |
|
Package tmpl implements a protobuf template-based generator.
|
Package tmpl implements a protobuf template-based generator. |
|
Package util implements utilities for building protoc compiler plugins.
|
Package util implements utilities for building protoc compiler plugins. |