1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
|
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
}
|