Help us shape the future of Go! Take the 2026 Go Developer Survey

openapigen

package
v0.255.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 12, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source
const Version = "3.1.0"

Version is the emitted document's OpenAPI version. 3.1 rather than 3.0 because a pinned body value needs JSON Schema `const`.

Variables

This section is empty.

Functions

func Emit

func Emit(descs []opcore.Descriptor, cfg Config) ([]byte, []string, error)

Emit renders descs as an OpenAPI 3.1 document. Descriptors reaching something other than a URL are skipped; Skipped names them.

Types

type Config

type Config struct {
	Title   string
	Descr   string
	Version string
	BaseURL string
}

Config carries what the descriptors do not: the document's own identity.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL