protoc-gen-apidocs icon indicating copy to clipboard operation
protoc-gen-apidocs copied to clipboard

Generate beautiful documentation from your Protobuf descriptors.

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.

  • Output markdown
  • Source proto

Booking.proto example

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

  • Output markdown
  • Source proto