Skip to content

Commit 6318650

Browse files
fredmaggiowskifredmaggiowski
committed
:s/swagger/openapi/g
1 parent 63d62ff commit 6318650

30 files changed

+120
-120
lines changed

‎main.go‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ type Options struct {
5151
PathPrefix string
5252
}
5353

54-
// NewRouter generate new router with swagger. Default to OpenAPI 3.0.0
54+
// NewRouter generate new router with openapi. Default to OpenAPI 3.0.0
5555
func NewRouter[HandlerFunc, Route any](router apirouter.Router[HandlerFunc, Route], options Options) (*Router[HandlerFunc, Route], error) {
56-
swagger, err := generateNewValidOpenapi(options.Openapi)
56+
openapi, err := generateNewValidOpenapi(options.Openapi)
5757
if err != nil {
5858
return nil, fmt.Errorf("%w: %s", ErrValidatingOAS, err)
5959
}
@@ -81,7 +81,7 @@ func NewRouter[HandlerFunc, Route any](router apirouter.Router[HandlerFunc, Rout
8181

8282
return &Router[HandlerFunc, Route]{
8383
router: router,
84-
swaggerSchema: swagger,
84+
swaggerSchema: openapi,
8585
context: ctx,
8686
yamlDocumentationPath: yamlDocumentationPath,
8787
jsonDocumentationPath: jsonDocumentationPath,
@@ -104,28 +104,28 @@ func (r Router[HandlerFunc, Route]) SubRouter(router apirouter.Router[HandlerFun
104104
}, nil
105105
}
106106

107-
func generateNewValidOpenapi(swagger *openapi3.T) (*openapi3.T, error) {
108-
if swagger == nil {
109-
return nil, fmt.Errorf("swagger is required")
107+
func generateNewValidOpenapi(openapi *openapi3.T) (*openapi3.T, error) {
108+
if openapi == nil {
109+
return nil, fmt.Errorf("openapi is required")
110110
}
111-
if swagger.OpenAPI == "" {
112-
swagger.OpenAPI = defaultOpenapiVersion
111+
if openapi.OpenAPI == "" {
112+
openapi.OpenAPI = defaultOpenapiVersion
113113
}
114-
if swagger.Paths == nil {
115-
swagger.Paths = &openapi3.Paths{}
114+
if openapi.Paths == nil {
115+
openapi.Paths = &openapi3.Paths{}
116116
}
117117

118-
if swagger.Info == nil {
119-
return nil, fmt.Errorf("swagger info is required")
118+
if openapi.Info == nil {
119+
return nil, fmt.Errorf("openapi info is required")
120120
}
121-
if swagger.Info.Title == "" {
122-
return nil, fmt.Errorf("swagger info title is required")
121+
if openapi.Info.Title == "" {
122+
return nil, fmt.Errorf("openapi info title is required")
123123
}
124-
if swagger.Info.Version == "" {
125-
return nil, fmt.Errorf("swagger info version is required")
124+
if openapi.Info.Version == "" {
125+
return nil, fmt.Errorf("openapi info version is required")
126126
}
127127

128-
return swagger, nil
128+
return openapi, nil
129129
}
130130

131131
// GenerateAndExposeOpenapi creates a /documentation/json route on router and

‎main_test.go‎

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ func TestNewRouter(t *testing.T) {
3333
r, err := NewRouter(mAPIRouter, Options{})
3434

3535
require.Nil(t, r)
36-
require.EqualError(t, err, fmt.Sprintf("%s: swagger is required", ErrValidatingOAS))
36+
require.EqualError(t, err, fmt.Sprintf("%s: openapi is required", ErrValidatingOAS))
3737
})
3838

3939
t.Run("ok - with default context", func(t *testing.T) {
@@ -119,73 +119,73 @@ func TestNewRouter(t *testing.T) {
119119
}
120120

121121
func TestGenerateValidSwagger(t *testing.T) {
122-
t.Run("not ok - empty swagger info", func(t *testing.T) {
123-
swagger := &openapi3.T{}
122+
t.Run("not ok - empty openapi info", func(t *testing.T) {
123+
openapi := &openapi3.T{}
124124

125-
swagger, err := generateNewValidOpenapi(swagger)
126-
require.Nil(t, swagger)
127-
require.EqualError(t, err, "swagger info is required")
125+
openapi, err := generateNewValidOpenapi(openapi)
126+
require.Nil(t, openapi)
127+
require.EqualError(t, err, "openapi info is required")
128128
})
129129

130130
t.Run("not ok - empty info title", func(t *testing.T) {
131-
swagger := &openapi3.T{
131+
openapi := &openapi3.T{
132132
Info: &openapi3.Info{},
133133
}
134134

135-
swagger, err := generateNewValidOpenapi(swagger)
136-
require.Nil(t, swagger)
137-
require.EqualError(t, err, "swagger info title is required")
135+
openapi, err := generateNewValidOpenapi(openapi)
136+
require.Nil(t, openapi)
137+
require.EqualError(t, err, "openapi info title is required")
138138
})
139139

140140
t.Run("not ok - empty info version", func(t *testing.T) {
141-
swagger := &openapi3.T{
141+
openapi := &openapi3.T{
142142
Info: &openapi3.Info{
143143
Title: "title",
144144
},
145145
}
146146

147-
swagger, err := generateNewValidOpenapi(swagger)
148-
require.Nil(t, swagger)
149-
require.EqualError(t, err, "swagger info version is required")
147+
openapi, err := generateNewValidOpenapi(openapi)
148+
require.Nil(t, openapi)
149+
require.EqualError(t, err, "openapi info version is required")
150150
})
151151

152-
t.Run("ok - custom swagger", func(t *testing.T) {
153-
swagger := &openapi3.T{
152+
t.Run("ok - custom openapi", func(t *testing.T) {
153+
openapi := &openapi3.T{
154154
Info: &openapi3.Info{},
155155
}
156156

157-
swagger, err := generateNewValidOpenapi(swagger)
158-
require.Nil(t, swagger)
159-
require.EqualError(t, err, "swagger info title is required")
157+
openapi, err := generateNewValidOpenapi(openapi)
158+
require.Nil(t, openapi)
159+
require.EqualError(t, err, "openapi info title is required")
160160
})
161161

162-
t.Run("not ok - swagger is required", func(t *testing.T) {
163-
swagger, err := generateNewValidOpenapi(nil)
164-
require.Nil(t, swagger)
165-
require.EqualError(t, err, "swagger is required")
162+
t.Run("not ok - openapi is required", func(t *testing.T) {
163+
openapi, err := generateNewValidOpenapi(nil)
164+
require.Nil(t, openapi)
165+
require.EqualError(t, err, "openapi is required")
166166
})
167167

168168
t.Run("ok", func(t *testing.T) {
169169
info := &openapi3.Info{
170170
Title: "my title",
171171
Version: "my version",
172172
}
173-
swagger := &openapi3.T{
173+
openapi := &openapi3.T{
174174
Info: info,
175175
}
176176

177-
swagger, err := generateNewValidOpenapi(swagger)
177+
openapi, err := generateNewValidOpenapi(openapi)
178178
require.NoError(t, err)
179179
require.Equal(t, &openapi3.T{
180180
OpenAPI: defaultOpenapiVersion,
181181
Info: info,
182182
Paths: &openapi3.Paths{},
183-
}, swagger)
183+
}, openapi)
184184
})
185185
}
186186

187187
func TestGenerateAndExposeSwagger(t *testing.T) {
188-
t.Run("fails swagger validation", func(t *testing.T) {
188+
t.Run("fails openapi validation", func(t *testing.T) {
189189
mRouter := mux.NewRouter()
190190
router, err := NewRouter(gorilla.NewRouter(mRouter), Options{
191191
Openapi: &openapi3.T{
@@ -207,14 +207,14 @@ func TestGenerateAndExposeSwagger(t *testing.T) {
207207
require.True(t, strings.HasPrefix(err.Error(), fmt.Sprintf("%s:", ErrValidatingOAS)))
208208
})
209209

210-
t.Run("correctly expose json documentation from loaded swagger file", func(t *testing.T) {
210+
t.Run("correctly expose json documentation from loaded openapi file", func(t *testing.T) {
211211
mRouter := mux.NewRouter()
212212

213-
swagger, err := openapi3.NewLoader().LoadFromFile("testdata/users_employees.json")
213+
openapi, err := openapi3.NewLoader().LoadFromFile("testdata/users_employees.json")
214214
require.NoError(t, err)
215215

216216
router, err := NewRouter(gorilla.NewRouter(mRouter), Options{
217-
Openapi: swagger,
217+
Openapi: openapi,
218218
})
219219
require.NoError(t, err)
220220

@@ -234,14 +234,14 @@ func TestGenerateAndExposeSwagger(t *testing.T) {
234234
require.JSONEq(t, string(actual), body)
235235
})
236236

237-
t.Run("correctly expose json documentation from loaded swagger file - custom path", func(t *testing.T) {
237+
t.Run("correctly expose json documentation from loaded openapi file - custom path", func(t *testing.T) {
238238
mRouter := mux.NewRouter()
239239

240-
swagger, err := openapi3.NewLoader().LoadFromFile("testdata/users_employees.json")
240+
openapi, err := openapi3.NewLoader().LoadFromFile("testdata/users_employees.json")
241241
require.NoError(t, err)
242242

243243
router, err := NewRouter(gorilla.NewRouter(mRouter), Options{
244-
Openapi: swagger,
244+
Openapi: openapi,
245245
JSONDocumentationPath: "/custom/path",
246246
})
247247
require.NoError(t, err)
@@ -262,14 +262,14 @@ func TestGenerateAndExposeSwagger(t *testing.T) {
262262
require.JSONEq(t, string(actual), body)
263263
})
264264

265-
t.Run("correctly expose yaml documentation from loaded swagger file", func(t *testing.T) {
265+
t.Run("correctly expose yaml documentation from loaded openapi file", func(t *testing.T) {
266266
mRouter := mux.NewRouter()
267267

268-
swagger, err := openapi3.NewLoader().LoadFromFile("testdata/users_employees.json")
268+
openapi, err := openapi3.NewLoader().LoadFromFile("testdata/users_employees.json")
269269
require.NoError(t, err)
270270

271271
router, err := NewRouter(gorilla.NewRouter(mRouter), Options{
272-
Openapi: swagger,
272+
Openapi: openapi,
273273
})
274274
require.NoError(t, err)
275275

@@ -289,14 +289,14 @@ func TestGenerateAndExposeSwagger(t *testing.T) {
289289
require.YAMLEq(t, string(expected), body, string(body))
290290
})
291291

292-
t.Run("correctly expose yaml documentation from loaded swagger file - custom path", func(t *testing.T) {
292+
t.Run("correctly expose yaml documentation from loaded openapi file - custom path", func(t *testing.T) {
293293
mRouter := mux.NewRouter()
294294

295-
swagger, err := openapi3.NewLoader().LoadFromFile("testdata/users_employees.json")
295+
openapi, err := openapi3.NewLoader().LoadFromFile("testdata/users_employees.json")
296296
require.NoError(t, err)
297297

298298
router, err := NewRouter(gorilla.NewRouter(mRouter), Options{
299-
Openapi: swagger,
299+
Openapi: openapi,
300300
YAMLDocumentationPath: "/custom/path",
301301
})
302302
require.NoError(t, err)
@@ -323,8 +323,8 @@ func TestGenerateAndExposeSwagger(t *testing.T) {
323323
router, err := NewRouter(gorilla.NewRouter(mRouter), Options{
324324
Openapi: &openapi3.T{
325325
Info: &openapi3.Info{
326-
Title: "test swagger title",
327-
Version: "test swagger version",
326+
Title: "test openapi title",
327+
Version: "test openapi version",
328328
},
329329
},
330330
JSONDocumentationPath: "/custom/path",
@@ -402,8 +402,8 @@ func TestGenerateAndExposeSwagger(t *testing.T) {
402402
router, err := NewRouter(gorilla.NewRouter(mRouter), Options{
403403
Openapi: &openapi3.T{
404404
Info: &openapi3.Info{
405-
Title: "test swagger title",
406-
Version: "test swagger version",
405+
Title: "test openapi title",
406+
Version: "test openapi version",
407407
},
408408
},
409409
JSONDocumentationPath: "/custom/path",

‎operation_test.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ func TestNewOperation(t *testing.T) {
2727
operation.Responses = openapi3.NewResponses()
2828
return operation
2929
},
30-
expectedJSON: `{"info":{"title":"test swagger title","version":"test swagger version"},"openapi":"3.0.0","paths":{"/":{"post":{"requestBody":{"content":{"application/json":{"schema":{"properties":{"bar":{"maximum":15,"minimum":5,"type":"integer"},"foo":{"type":"string"}},"type":"object"}}}},"responses":{"default":{"description":""}}}}}}`,
30+
expectedJSON: `{"info":{"title":"test openapi title","version":"test openapi version"},"openapi":"3.0.0","paths":{"/":{"post":{"requestBody":{"content":{"application/json":{"schema":{"properties":{"bar":{"maximum":15,"minimum":5,"type":"integer"},"foo":{"type":"string"}},"type":"object"}}}},"responses":{"default":{"description":""}}}}}}`,
3131
},
3232
{
3333
name: "add response",
@@ -36,19 +36,19 @@ func TestNewOperation(t *testing.T) {
3636
operation.AddResponse(200, response)
3737
return operation
3838
},
39-
expectedJSON: `{"info":{"title":"test swagger title","version":"test swagger version"},"openapi":"3.0.0","paths":{"/":{"post":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"bar":{"maximum":15,"minimum":5,"type":"integer"},"foo":{"type":"string"}},"type":"object"}}},"description":""}}}}}}`,
39+
expectedJSON: `{"info":{"title":"test openapi title","version":"test openapi version"},"openapi":"3.0.0","paths":{"/":{"post":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"bar":{"maximum":15,"minimum":5,"type":"integer"},"foo":{"type":"string"}},"type":"object"}}},"description":""}}}}}}`,
4040
},
4141
}
4242

4343
for _, test := range tests {
4444
t.Run(test.name, func(t *testing.T) {
45-
swagger := getBaseSwagger(t)
46-
swagger.OpenAPI = "3.0.0"
45+
openapi := getBaseSwagger(t)
46+
openapi.OpenAPI = "3.0.0"
4747
operation := test.getOperation(t, NewOperation())
4848

49-
swagger.AddOperation("/", http.MethodPost, operation.Operation)
49+
openapi.AddOperation("/", http.MethodPost, operation.Operation)
5050

51-
data, _ := swagger.MarshalJSON()
51+
data, _ := openapi.MarshalJSON()
5252
jsonData := string(data)
5353
require.JSONEq(t, test.expectedJSON, jsonData, "actual json data: %s", jsonData)
5454
})

‎route.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ var (
2424
)
2525

2626
// AddRawRoute add route to router with specific method, path and handler. Add the
27-
// router also to the swagger schema, after validating it
27+
// router also to the openapi schema, after validating it
2828
func (r Router[HandlerFunc, Route]) AddRawRoute(method string, routePath string, handler HandlerFunc, operation Operation) (Route, error) {
2929
op := operation.Operation
3030
if op != nil {

‎route_test.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -533,7 +533,7 @@ func TestAddRoutes(t *testing.T) {
533533
require.Equal(t, "OK", body)
534534
}
535535

536-
t.Run("and generate swagger documentation in json", func(t *testing.T) {
536+
t.Run("and generate openapi documentation in json", func(t *testing.T) {
537537
w := httptest.NewRecorder()
538538
req := httptest.NewRequest(http.MethodGet, DefaultJSONDocumentationPath, nil)
539539

@@ -1116,8 +1116,8 @@ func getBaseSwagger(t *testing.T) *openapi3.T {
11161116

11171117
return &openapi3.T{
11181118
Info: &openapi3.Info{
1119-
Title: "test swagger title",
1120-
Version: "test swagger version",
1119+
Title: "test openapi title",
1120+
Version: "test openapi version",
11211121
},
11221122
}
11231123
}

‎support/echo/integration_test.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ import (
1717
)
1818

1919
const (
20-
swaggerOpenapiTitle = "test swagger title"
21-
swaggerOpenapiVersion = "test swagger version"
20+
swaggerOpenapiTitle = "test openapi title"
21+
swaggerOpenapiVersion = "test openapi version"
2222
)
2323

2424
type echoSwaggerRouter = swagger.Router[echo.HandlerFunc, *echo.Route]

‎support/fiber/integration_test.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ import (
1919
type SwaggerRouter = swagger.Router[oasFiber.HandlerFunc, oasFiber.Route]
2020

2121
const (
22-
swaggerOpenapiTitle = "test swagger title"
23-
swaggerOpenapiVersion = "test swagger version"
22+
swaggerOpenapiTitle = "test openapi title"
23+
swaggerOpenapiVersion = "test openapi version"
2424
)
2525

2626
func TestFiberIntegration(t *testing.T) {

‎support/gorilla/integration_test.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ import (
1616
)
1717

1818
const (
19-
swaggerOpenapiTitle = "test swagger title"
20-
swaggerOpenapiVersion = "test swagger version"
19+
swaggerOpenapiTitle = "test openapi title"
20+
swaggerOpenapiVersion = "test openapi version"
2121
)
2222

2323
type SwaggerRouter = swagger.Router[gorilla.HandlerFunc, gorilla.Route]

‎support/testdata/integration.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"info": {
3-
"title": "test swagger title",
4-
"version": "test swagger version"
3+
"title": "test openapi title",
4+
"version": "test openapi version"
55
},
66
"openapi": "3.0.0",
77
"paths": {

‎support/testdata/intergation-subrouter.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"info": {
3-
"title": "test swagger title",
4-
"version": "test swagger version"
3+
"title": "test openapi title",
4+
"version": "test openapi version"
55
},
66
"openapi": "3.0.0",
77
"paths": {

0 commit comments

Comments
 (0)