routers

package

v0.60.0 Latest Latest Go to latest Published: Apr 23, 2021 License: MIT Imports: 2 Imported by: 272

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/getkin/kin-openapi

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type Route
type RouteError
- func (e *RouteError) Error() string
type Router

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrMethodNotAllowed error = &RouteError{"method not allowed"}

ErrMethodNotAllowed is returned when no method of the matched route matches

View Source

var ErrPathNotFound error = &RouteError{"no matching operation was found"}

ErrPathNotFound is returned when no route match is found

Functions ¶

This section is empty.

Types ¶

type Route ¶

type Route struct {
	Swagger   *openapi3.Swagger
	Server    *openapi3.Server
	Path      string
	PathItem  *openapi3.PathItem
	Method    string
	Operation *openapi3.Operation
}

Route describes the operation an http.Request can match

type RouteError ¶

type RouteError struct {
	Reason string
}

RouteError describes Router errors

func (*RouteError) Error ¶

func (e *RouteError) Error() string

type Router ¶

type Router interface {
	FindRoute(req *http.Request) (route *Route, pathParams map[string]string, err error)
}

Router helps link http.Request.s and an OpenAPIv3 spec

Source Files ¶

View all Source files

types.go

Directories ¶

Path	Synopsis
gorillamux Package gorillamux implements a router.	Package gorillamux implements a router.
legacy Package legacy implements a router.	Package legacy implements a router.
pathpattern Package pathpattern implements path matching.	Package pathpattern implements path matching.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL