https://github.com/tmc/protoc-gen-apidocs

Generate beautiful documentation from your Protobuf descriptors.
https://github.com/tmc/protoc-gen-apidocs

go golang grpc protobuf

Last synced: 12 days ago
JSON representation

Generate beautiful documentation from your Protobuf descriptors.

• Host: GitHub
• URL: https://github.com/tmc/protoc-gen-apidocs
• Owner: tmc
• Created: 2022-01-20T04:41:31.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-04-24T18:27:15.000Z (7 months ago)
• Last Synced: 2024-10-13T23:09:17.338Z (26 days ago)
• Topics: go, golang, grpc, protobuf
• Language: Go
• Homepage:
• Size: 52.7 KB
• Stars: 29
• Watchers: 2
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-grpc - protoc-gen-apidocs - Documentation generator plugin for protobuf/gRPC. (Protocol Buffers / Tools)

README

        
# 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](https://pkg.go.dev/google.golang.org/protobuf/compiler/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](./testdata/example1/vehicle.md)

* [Source proto](./testdata/example1/vehicle.proto)

**Booking.proto example**

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

* [Output markdown](./testdata/example1/booking.md)

* [Source proto](./testdata/example1/booking.proto)