Documentation
¶
Overview ¶
Package apidoc generates API documentation (OpenAPI, AsyncAPI) from message protocols.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Generator ¶
type Generator struct{}
Generator generates API documentation from message schemas.
func (*Generator) GenerateAsyncAPI ¶
func (g *Generator) GenerateAsyncAPI(ms *schema.MessageSchema) (string, error)
GenerateAsyncAPI generates an AsyncAPI 2.6 spec from a message schema.
func (*Generator) GenerateOpenAPI ¶
func (g *Generator) GenerateOpenAPI(ms *schema.MessageSchema) (string, error)
GenerateOpenAPI generates an OpenAPI 3.0 spec from a message schema.
Source Files
Click to show internal directories.
Click to hide internal directories.