Skip to content

Generate beautiful documentation from your Protobuf descriptors.

Notifications You must be signed in to change notification settings

tmc/protoc-gen-apidocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

protoc-gen-apidocs

protoc-gen-apidocs is a very simple and customizable protoc generator that translates .proto files into clean and readable markdown format.

This is achieved by levearging the fantastic protogen library and Go's built-in templating capabilties.

Example Output

Vehicle.proto example

This example shows a variety of protobuf features including extensions and nested messages.

Booking.proto example

This example is relatively simple but shows streaming rpc endpoints properly handled.

About

Generate beautiful documentation from your Protobuf descriptors.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published