oapi

Documentation

Index

• func MergeWithRoot(root spec.OpenAPI, c container.Container) (err error)
• func SetPathsDefaults(cnt container.Container, defops map[string]spec.Operation) (err error)
• type FlattenPath
• type FlattenPaths
  • func Paths(cnt container.Container) (ff FlattenPaths, err error)
  • func (fp FlattenPaths) Match(pattern string) (xx FlattenPaths, err error)

Functions

func MergeWithRoot

func MergeWithRoot(root spec.OpenAPI, c container.Container) (err error)

MergeWithRoot will merge container with root document.

func SetPathsDefaults

func SetPathsDefaults(cnt container.Container, defops map[string]spec.Operation) (err error)

SetPathsDefaults will iterate through paths and apply default on each path. This might be useful for supplying default headers or default responses.

Types

type FlattenPath

type FlattenPath struct {
	Method    string
	Path      string
	Key       string
	Operation container.Container
}

FlattenPath represents single reuqest path in oapi spec.

type FlattenPaths

type FlattenPaths []FlattenPath

FlattenPaths list of FlattenPath

func Paths

func Paths(cnt container.Container) (ff FlattenPaths, err error)

Paths will parse paths in oapi container and return array of paths.

func (FlattenPaths) Match

func (fp FlattenPaths) Match(pattern string) (xx FlattenPaths, err error)

Match will match given path to given route