openapi

Documentation

Index

• func IsGraphQLSDL(data []byte) bool
• func IsOpenAPI(data []byte) bool
• func Parse(data []byte) (*spec.APISpec, error)
• func ParseLenient(data []byte) (*spec.APISpec, error)
• func SetMaxEndpointsPerResource(n int)
• func SetMaxResources(n int)

Functions

func IsGraphQLSDL

func IsGraphQLSDL(data []byte) bool

func IsOpenAPI

func IsOpenAPI(data []byte) bool

func Parse

func Parse(data []byte) (*spec.APISpec, error)

Parse parses an OpenAPI spec strictly. Use ParseLenient for specs with broken $refs.

func ParseLenient

func ParseLenient(data []byte) (*spec.APISpec, error)

ParseLenient parses an OpenAPI spec, skipping validation errors from broken $refs. It logs warnings to stderr for any issues found but continues parsing.

func SetMaxEndpointsPerResource

func SetMaxEndpointsPerResource(n int)

SetMaxEndpointsPerResource overrides the default limit and disables auto-calibration. When not called, the parser auto-calibrates the limit from the spec so well-formed specs never have endpoints silently skipped.

func SetMaxResources

func SetMaxResources(n int)

SetMaxResources overrides the default resource limit. When not called, the parser uses a default of 500 which accommodates all known APIs.