sourcegraph/prototools

Name: prototools

Owner: Sourcegraph

Description: documentation generator & other tools for protobuf/gRPC

Created: 2015-04-29 10:52:54.0

Updated: 2018-05-21 13:51:36.0

Pushed: 2017-01-05 07:27:50.0

Homepage:

Size: 72

Language: Go

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

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.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.