PhoenixSpec.OpenAPI (PhoenixSpec v0.1.1)

View Source

Generates an OpenAPI 3.1 specification from extracted view and schema information.

Summary

Functions

Builds a complete OpenAPI 3.1 document.

Encodes the spec as JSON.

Encodes the spec as YAML.

Functions

generate(opts \\ [])

@spec generate(keyword()) :: map()

Builds a complete OpenAPI 3.1 document.

to_json(spec)

@spec to_json(map()) :: String.t()

Encodes the spec as JSON.

to_yaml(spec)

@spec to_yaml(map()) :: String.t()

Encodes the spec as YAML.