Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewPlugin ¶
func NewPlugin(s *grpc.Server, opts ...Option) docshandler.Plugin
NewPlugin returns a docshandler.Plugin for generating documentation for a grpc.Server. See Option for configuration settings for this plugin. Note that currently when using this plugin, the docs handler must be served at the root, not at a prefix such as "/docs/".
Types ¶
type Option ¶
type Option func(*config)
Option is a configuration option for NewPlugin.
func WithExampleRequests ¶
WithExampleRequests registers example requests for a method which can be selected in the debug form of the docs page. The method name should be in the format "service/method", e.g., "greet.GreetService/Greet".
func WithSerializedDescriptors ¶
WithSerializedDescriptors registers serialized proto descriptors to use for extracting docstrings in documentation.
Source Files
Click to show internal directories.
Click to hide internal directories.