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
|
package openapi3filter_test
import (
"net/http"
"sort"
"testing"
"github.com/getkin/kin-openapi/openapi3"
"github.com/getkin/kin-openapi/openapi3filter"
"github.com/stretchr/testify/require"
)
func TestRouter(t *testing.T) {
var (
pathNotFound = "Path was not found"
methodNotAllowed = "Path doesn't support the HTTP method"
doesNotMatchAnyServer = "Does not match any server"
)
// Build swagger
helloCONNECT := &openapi3.Operation{Responses: openapi3.NewResponses()}
helloDELETE := &openapi3.Operation{Responses: openapi3.NewResponses()}
helloGET := &openapi3.Operation{Responses: openapi3.NewResponses()}
helloHEAD := &openapi3.Operation{Responses: openapi3.NewResponses()}
helloOPTIONS := &openapi3.Operation{Responses: openapi3.NewResponses()}
helloPATCH := &openapi3.Operation{Responses: openapi3.NewResponses()}
helloPOST := &openapi3.Operation{Responses: openapi3.NewResponses()}
helloPUT := &openapi3.Operation{Responses: openapi3.NewResponses()}
helloTRACE := &openapi3.Operation{Responses: openapi3.NewResponses()}
paramsGET := &openapi3.Operation{Responses: openapi3.NewResponses()}
partialGET := &openapi3.Operation{Responses: openapi3.NewResponses()}
swagger := &openapi3.Swagger{
OpenAPI: "3.0.0",
Info: &openapi3.Info{
Title: "MyAPI",
Version: "0.1",
},
Paths: openapi3.Paths{
"/hello": &openapi3.PathItem{
Connect: helloCONNECT,
Delete: helloDELETE,
Get: helloGET,
Head: helloHEAD,
Options: helloOPTIONS,
Patch: helloPATCH,
Post: helloPOST,
Put: helloPUT,
Trace: helloTRACE,
},
"/onlyGET": &openapi3.PathItem{
Get: helloGET,
},
"/params/{x}/{y}/{z*}": &openapi3.PathItem{
Get: paramsGET,
Parameters: openapi3.Parameters{
&openapi3.ParameterRef{Value: openapi3.NewPathParameter("x")},
&openapi3.ParameterRef{Value: openapi3.NewPathParameter("y")},
&openapi3.ParameterRef{Value: openapi3.NewPathParameter("z")},
},
},
"/partial": &openapi3.PathItem{
Get: partialGET,
},
},
}
// Build router
router := openapi3filter.NewRouter().WithSwagger(swagger)
// Declare a helper function
expect := func(method string, uri string, operation *openapi3.Operation, params map[string]string) {
req, err := http.NewRequest(method, uri, nil)
require.NoError(t, err)
route, pathParams, err := router.FindRoute(req.Method, req.URL)
if err != nil {
if operation == nil {
if err.Error() == doesNotMatchAnyServer {
return
}
pathItem := swagger.Paths[uri]
if pathItem == nil {
if err.Error() != pathNotFound {
t.Fatalf("'%s %s': should have returned '%s', but it returned an error: %v",
method, uri, pathNotFound, err)
}
return
}
if pathItem.GetOperation(method) == nil {
if err.Error() != methodNotAllowed {
t.Fatalf("'%s %s': should have returned '%s', but it returned an error: %v",
method, uri, methodNotAllowed, err)
}
}
} else {
t.Fatalf("'%s %s': should have returned an operation, but it returned an error: %v",
method, uri, err)
}
}
if operation == nil && err == nil {
t.Fatalf("'%s %s': should have returned an error, but didn't",
method, uri)
}
if route == nil {
return
}
if route.Operation != operation {
t.Fatalf("'%s %s': Returned wrong operation (%v)",
method, uri, route.Operation)
}
if params == nil {
if len(pathParams) != 0 {
t.Fatalf("'%s %s': should return no path arguments, but found some",
method, uri)
}
} else {
names := make([]string, 0, len(params))
for name := range params {
names = append(names, name)
}
sort.Strings(names)
for _, name := range names {
expected := params[name]
actual, exists := pathParams[name]
if !exists {
t.Fatalf("'%s %s': path parameter '%s' should be '%s', but it's not defined.",
method, uri, name, expected)
}
if actual != expected {
t.Fatalf("'%s %s': path parameter '%s' should be '%s', but it's '%s'",
method, uri, name, expected, actual)
}
}
}
}
expect(http.MethodGet, "/not_existing", nil, nil)
expect(http.MethodDelete, "/hello", helloDELETE, nil)
expect(http.MethodGet, "/hello", helloGET, nil)
expect(http.MethodHead, "/hello", helloHEAD, nil)
expect(http.MethodPatch, "/hello", helloPATCH, nil)
expect(http.MethodPost, "/hello", helloPOST, nil)
expect(http.MethodPut, "/hello", helloPUT, nil)
expect(http.MethodGet, "/params/a/b/c/d", paramsGET, map[string]string{
"x": "a",
"y": "b",
"z": "c/d",
})
expect(http.MethodPost, "/partial", nil, nil)
swagger.Servers = append(swagger.Servers, &openapi3.Server{
URL: "https://www.example.com/api/v1/",
}, &openapi3.Server{
URL: "https://{d0}.{d1}.com/api/v1/",
})
expect(http.MethodGet, "/hello", nil, nil)
expect(http.MethodGet, "/api/v1/hello", nil, nil)
expect(http.MethodGet, "www.example.com/api/v1/hello", nil, nil)
expect(http.MethodGet, "https:///api/v1/hello", nil, nil)
expect(http.MethodGet, "https://www.example.com/hello", nil, nil)
expect(http.MethodGet, "https://www.example.com/api/v1/hello", helloGET, map[string]string{})
expect(http.MethodGet, "https://domain0.domain1.com/api/v1/hello", helloGET, map[string]string{
"d0": "domain0",
"d1": "domain1",
})
{
uri := "https://www.example.com/api/v1/onlyGET"
expect(http.MethodGet, uri, helloGET, nil)
req, err := http.NewRequest(http.MethodDelete, uri, nil)
require.NoError(t, err)
require.NotNil(t, req)
route, pathParams, err := router.FindRoute(req.Method, req.URL)
require.Error(t, err)
require.Equal(t, err.(*openapi3filter.RouteError).Reason, "Path doesn't support the HTTP method")
require.Nil(t, route)
require.Nil(t, pathParams)
}
}
|
