openapi

Documentation

Overview

Package openapi provides documentation collector.

Index

• type Collector
  • func (c *Collector) Annotate(method, pattern string, setup ...func(op *openapi3.Operation) error)
  • func (c *Collector) Collect(method, pattern string, u usecase.Interactor, h rest.HandlerTrait, ...) (err error)
  • func (c *Collector) ProvideRequestJSONSchemas(method string, input interface{}, mapping rest.RequestMapping, ...) error
  • func (c *Collector) ProvideResponseJSONSchemas(statusCode int, contentType string, output interface{}, ...) error
  • func (c *Collector) Reflector() *openapi3.Reflector
  • func (c *Collector) ServeHTTP(rw http.ResponseWriter, _ *http.Request)

Types

type Collector

type Collector struct {
	BasePath string // URL path to docs, default "/docs/".

	// CombineErrors can take a value of "oneOf" or "anyOf",
	// if not empty it enables logical schema grouping in case
	// of multiple responses with same HTTP status code.
	CombineErrors string
	// contains filtered or unexported fields
}

Collector extracts OpenAPI documentation from HTTP handler and underlying use case interactor.

func (*Collector) Annotate

func (c *Collector) Annotate(method, pattern string, setup ...func(op *openapi3.Operation) error)

Annotate adds OpenAPI operation configuration that is applied during collection.

func (*Collector) Collect

func (c *Collector) Collect(
	method, pattern string,
	u usecase.Interactor,
	h rest.HandlerTrait,
	annotations ...func(*openapi3.Operation) error,
) (err error)

Collect adds use case handler to documentation.

func (*Collector) ProvideRequestJSONSchemas

func (c *Collector) ProvideRequestJSONSchemas(
	method string,
	input interface{},
	mapping rest.RequestMapping,
	validator rest.JSONSchemaValidator,
) error

ProvideRequestJSONSchemas provides JSON Schemas for request structure.

func (*Collector) ProvideResponseJSONSchemas

func (c *Collector) ProvideResponseJSONSchemas(
	statusCode int,
	contentType string,
	output interface{},
	headerMapping map[string]string,
	validator rest.JSONSchemaValidator,
) error

ProvideResponseJSONSchemas provides JSON schemas for response structure.

func (*Collector) Reflector

func (c *Collector) Reflector() *openapi3.Reflector

Reflector is an accessor to OpenAPI Reflector instance.

func (*Collector) ServeHTTP

func (c *Collector) ServeHTTP(rw http.ResponseWriter, _ *http.Request)