-
Notifications
You must be signed in to change notification settings - Fork 273
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
How to generate API reference from .proto
?
#741
Comments
Hi, thanks for your issue! Yes, you can use this plugin with If you're already a bit familiar with
EDIT: change |
Another option is to use the Buf Schema Registry's built-in documentation generator by the way! https://docs.buf.build/bsr/documentation |
Thank you! I am trying as following your instruction but, I've got the error message even though
I've also executed My version: v1
plugins:
- name: go
out: .
opt: paths=source_relative
- name: go-grpc
out: .
opt:
- paths=source_relative
- require_unimplemented_servers=false
- name: grpc-gateway
out: .
opt: paths=source_relative
- name: protoc-gen-doc
out: . And version: v1
deps:
- buf.build/googleapis/googleapis
lint:
use:
- DEFAULT
except:
- PACKAGE_DIRECTORY_MATCH
breaking:
use:
- FILE Do you have any ideas? |
What does
If you need more help, can you reach out on our Slack? https://buf.build/links/slack. This issue tracker isn't great for quick troubleshooting. |
oh, I should've provided it, too. This is exactly same as which protoc-gen-doc
/Users/keisukeumegaki/go/bin/protoc-gen-doc Besides, I've joined the Slack channel. |
Replied in Slack, but including here for posterity - your version: v1
plugins:
- name: go
out: .
opt: paths=source_relative
- name: go-grpc
out: .
opt:
- paths=source_relative
- require_unimplemented_servers=false
- name: grpc-gateway
out: .
opt: paths=source_relative
- name: doc
out: . |
It works! Thanks:pray: |
I had some trouble getting the
|
I would like to generate API reference from
.proto
files by usingbuf
like https://github.com/pseudomuto/protoc-gen-doc.Are there ways to do it?
The text was updated successfully, but these errors were encountered: