generator

Documentation

Index

• type Config
• type Generator
  • func New(format string) Generator
• type OpenAPIGenerator
  • func NewOpenAPIGenerator() *OpenAPIGenerator
  • func (g *OpenAPIGenerator) Generate(doc *spec.Documentation, config Config) error

Types

type Config

type Config struct {
	OutputFile  string // Caminho do arquivo de saída (opcional, padrão: docs/openapi.json)
	Title       string // Título da API (opcional, padrão: API Documentation)
	Description string // Descrição da API (opcional, padrão: API documentation generated by Gobiru)
	Version     string // Versão da API (opcional, padrão: 1.0.0)
}

Config contém as configurações para geração da documentação

type Generator

type Generator interface {
	Generate(doc *spec.Documentation, config Config) error
}

Generator define a interface para geração de documentação

func New

func New(format string) Generator

New cria um novo gerador baseado no formato

type OpenAPIGenerator

type OpenAPIGenerator struct{}

func NewOpenAPIGenerator

func NewOpenAPIGenerator() *OpenAPIGenerator

func (*OpenAPIGenerator) Generate

func (g *OpenAPIGenerator) Generate(doc *spec.Documentation, config Config) error