swagger

Documentation

Index

• type Generator
  • func NewDefaultGenerator(config *project.Config, apis *api.Definitions) *Generator
  • func NewGenerator(config *project.Config, apis *api.Definitions, ...) *Generator
  • func (g *Generator) Generate() (map[string]spec.Swagger, error)

Types

type Generator

type Generator struct {
	// contains filtered or unexported fields
}

Generator is for generating swagger specifications.

func NewDefaultGenerator

func NewDefaultGenerator(
	config *project.Config,
	apis *api.Definitions,
) *Generator

NewDefaultGenerator creates a swagger generator with default mappings.

func NewGenerator

func NewGenerator(
	config *project.Config,
	apis *api.Definitions,
	sourceMapping map[definition.Source]string,
	destinationMapping map[definition.Destination]string,
) *Generator

NewGenerator creates a swagger generator.

func (*Generator) Generate

func (g *Generator) Generate() (map[string]spec.Swagger, error)

Generate generates swagger specifications.