apidoc

Documentation

Overview

Package apidoc generates API documentation (OpenAPI, AsyncAPI) from message protocols.

Index

• type Generator
  • func NewGenerator() *Generator
  • func (g *Generator) GenerateAsyncAPI(ms *schema.MessageSchema) (string, error)
  • func (g *Generator) GenerateOpenAPI(ms *schema.MessageSchema) (string, error)

Types

type Generator

type Generator struct{}

Generator generates API documentation from message schemas.

func NewGenerator

func NewGenerator() *Generator

NewGenerator creates a new API doc generator.

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.