router.go

package openapi3filter

import (
	"context"
	"errors"
	"fmt"
	"net/http"
	"net/url"
	"strings"

	"github.com/getkin/kin-openapi/openapi3"
	"github.com/getkin/kin-openapi/pathpattern"
)

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

	// For developers who want use the router for handling too
	Handler http.Handler
}

// Routers maps a HTTP request to a Router.
type Routers []*Router

func (routers Routers) FindRoute(method string, url *url.URL) (*Router, *Route, map[string]string, error) {
	for _, router := range routers {
		// Skip routers that have DO NOT have servers
		if len(router.swagger.Servers) == 0 {
			continue
		}
		route, pathParams, err := router.FindRoute(method, url)
		if err == nil {
			return router, route, pathParams, nil
		}
	}
	for _, router := range routers {
		// Skip routers that DO have servers
		if len(router.swagger.Servers) > 0 {
			continue
		}
		route, pathParams, err := router.FindRoute(method, url)
		if err == nil {
			return router, route, pathParams, nil
		}
	}
	return nil, nil, nil, &RouteError{
		Reason: "None of the routers matches",
	}
}

// Router maps a HTTP request to an OpenAPI operation.
type Router struct {
	swagger  *openapi3.Swagger
	pathNode *pathpattern.Node
}

// NewRouter creates a new router.
//
// If the given Swagger has servers, router will use them.
// All operations of the Swagger will be added to the router.
func NewRouter() *Router {
	return &Router{}
}

// WithSwaggerFromFile loads the Swagger file and adds it using WithSwagger.
// Panics on any error.
func (router *Router) WithSwaggerFromFile(path string) *Router {
	if err := router.AddSwaggerFromFile(path); err != nil {
		panic(err)
	}
	return router
}

// WithSwagger adds all operations in the OpenAPI specification.
// Panics on any error.
func (router *Router) WithSwagger(swagger *openapi3.Swagger) *Router {
	if err := router.AddSwagger(swagger); err != nil {
		panic(err)
	}
	return router
}

// AddSwaggerFromFile loads the Swagger file and adds it using AddSwagger.
func (router *Router) AddSwaggerFromFile(path string) error {
	swagger, err := openapi3.NewSwaggerLoader().LoadSwaggerFromFile(path)
	if err != nil {
		return err
	}
	return router.AddSwagger(swagger)
}

// AddSwagger adds all operations in the OpenAPI specification.
func (router *Router) AddSwagger(swagger *openapi3.Swagger) error {
	if err := swagger.Validate(context.TODO()); err != nil {
		return fmt.Errorf("Validating Swagger failed: %v", err)
	}
	router.swagger = swagger
	root := router.node()
	for path, pathItem := range swagger.Paths {
		for method, operation := range pathItem.Operations() {
			method = strings.ToUpper(method)
			if err := root.Add(method+" "+path, &Route{
				Swagger:   swagger,
				Path:      path,
				PathItem:  pathItem,
				Method:    method,
				Operation: operation,
			}, nil); err != nil {
				return err
			}
		}
	}
	return nil
}

// AddRoute adds a route in the router.
func (router *Router) AddRoute(route *Route) error {
	method := route.Method
	if method == "" {
		return errors.New("Route is missing method")
	}
	method = strings.ToUpper(method)
	path := route.Path
	if path == "" {
		return errors.New("Route is missing path")
	}
	return router.node().Add(method+" "+path, router, nil)
}

func (router *Router) node() *pathpattern.Node {
	root := router.pathNode
	if root == nil {
		root = &pathpattern.Node{}
		router.pathNode = root
	}
	return root
}

func (router *Router) FindRoute(method string, url *url.URL) (*Route, map[string]string, error) {
	swagger := router.swagger

	// Get server
	servers := swagger.Servers
	var server *openapi3.Server
	var remainingPath string
	var pathParams map[string]string
	if len(servers) == 0 {
		remainingPath = url.Path
	} else {
		var paramValues []string
		server, paramValues, remainingPath = servers.MatchURL(url)
		if server == nil {
			return nil, nil, &RouteError{
				Route: Route{
					Swagger: swagger,
				},
				Reason: "Does not match any server",
			}
		}
		pathParams = make(map[string]string, 8)
		paramNames, _ := server.ParameterNames()
		for i, value := range paramValues {
			name := paramNames[i]
			pathParams[name] = value
		}
	}

	// Get PathItem
	root := router.node()
	var route *Route
	node, paramValues := root.Match(method + " " + remainingPath)
	if node != nil {
		route, _ = node.Value.(*Route)
	}
	if route == nil {
		return nil, nil, &RouteError{
			Route: Route{
				Swagger: swagger,
				Server:  server,
			},
			Reason: "Path was not found",
		}
	}

	// Get operation
	pathItem := route.PathItem
	operation := pathItem.GetOperation(method)
	if operation == nil {
		return nil, nil, &RouteError{
			Route: Route{
				Swagger: swagger,
				Server:  server,
			},
			Reason: "Path doesn't support the HTTP method",
		}
	}
	if pathParams == nil {
		pathParams = make(map[string]string, len(paramValues))
	}
	paramKeys := node.VariableNames
	for i, value := range paramValues {
		key := paramKeys[i]
		if strings.HasSuffix(key, "*") {
			key = key[:len(key)-1]
		}
		pathParams[key] = value
	}
	return route, pathParams, nil
}