openapi

Documentation

Index

• func Spec(config Config, routes []Route) map[string]any
• type Config
• type Operation
• type Route
• type SecurityScheme

Functions

func Spec

func Spec(config Config, routes []Route) map[string]any

Types

type Config

type Config struct {
	Title           string
	Version         string
	SecuritySchemes []SecurityScheme
}

type Operation

type Operation struct {
	OperationID string
	Summary     string
	Description string
	Tags        []string
	Status      int
	Security    []string
}

type Route

type Route struct {
	Method    string
	Path      string
	Operation Operation
	Input     reflect.Type
	Output    reflect.Type
}

type SecurityScheme

type SecurityScheme struct {
	Name   string
	Type   string
	Scheme string
	In     string
}