render

package

v0.36.4 Latest Latest Go to latest Published: Aug 21, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/go-openapi/codescan

Links

Open Source Insights

Documentation ¶

Overview ¶

Package render marshals a spec and writes it to the desired format.

Index ¶

func Spec(doc *spec.Swagger, cfg Config) (asJSON []byte, err error)
type Config

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Spec ¶

func Spec(doc *spec.Swagger, cfg Config) (asJSON []byte, err error)

Spec marshals the specification document in the format asked for.

The JSON rendering is produced either way: it is what YAML is derived from, and what -validate checks, so a caller reading the document and a caller validating it are looking at the same bytes.

Types ¶

type Config ¶

type Config struct {
	CompactJSON bool
	WantsYAML   bool
	Output      string
	Stdout      io.Writer
}

Config holds the spec rendering settings.

Source Files ¶

View all Source files

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