middleware

Documentation

Overview

Package middleware implements middleware function for go-chi or net/http, which validates incoming HTTP requests to make sure that they conform to the given OAPI 3.0 specification. When OAPI validation failes on the request, we return an HTTP/400.

Index

• func OapiRequestValidator(swagger *openapi3.T) func(next http.Handler) http.Handler
• func OapiRequestValidatorWithOptions(swagger *openapi3.T, options *Options) func(next http.Handler) http.Handler
• type ErrorHandler
• type Options

Functions

func OapiRequestValidator

func OapiRequestValidator(swagger *openapi3.T) func(next http.Handler) http.Handler

OapiRequestValidator Creates middleware to validate request by swagger spec. This middleware is good for net/http either since go-chi is 100% compatible with net/http.

func OapiRequestValidatorWithOptions

func OapiRequestValidatorWithOptions(swagger *openapi3.T, options *Options) func(next http.Handler) http.Handler

OapiRequestValidatorWithOptions Creates middleware to validate request by swagger spec. This middleware is good for net/http either since go-chi is 100% compatible with net/http.

Types

type ErrorHandler

type ErrorHandler func(w http.ResponseWriter, message string, statusCode int)

ErrorHandler is called when there is an error in validation

type Options

type Options struct {
	Options      openapi3filter.Options
	ErrorHandler ErrorHandler
}

Options to customize request validation, openapi3filter specified options will be passed through.