Upgrade version to v0.10.1

Bumps [github.com/gofiber/fiber/v2](https://github.com/gofiber/fiber) from 2.52.4 to 2.52.5.
- [Release notes](https://github.com/gofiber/fiber/releases)
- [Commits](https://github.com/gofiber/fiber/compare/v2.52.4...v2.52.5)

---
updated-dependencies:
- dependency-name: github.com/gofiber/fiber/v2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.github/workflows/test-builds.yml

@@ -9,10 +9,10 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        go_version: [1.16, 1.17, 1.18, 1.19]
+        go_version: ['1.24', '1.25']
         os: [ubuntu-latest]
         include:
-        - go_version: 1.17
+        - go_version: '1.25'
           os: macos-latest
     steps:
       - uses: actions/checkout@v1
@@ -37,3 +37,14 @@ jobs:
         uses: shogo82148/actions-goveralls@v1
         with:
           path-to-profile: cover.out
+          flag-name: Go-${{ matrix.go_version }}
+          parallel: true
+
+  post-tests:
+    runs-on: ubuntu-latest
+    needs: tests
+    steps:
+      - name: Close coverage report
+        uses: shogo82148/actions-goveralls@v1
+        with:
+          parallel-finished: true

CHANGELOG.md

@@ -7,6 +7,66 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## 0.10.1 - 06-10-2025
+
+### Refactor
+
+- renamed swagger to openapi in error messages
+
+## 0.10.0 - 28-02-2024
+
+### BREAKING CHANGES
+
+- remove support to golang 1.19
+
+### Updated
+
+- change jsonschema lib to use again `invopop/jsonschema` one, since now it support additionalProperties instead of patternProperties
+
+## 0.9.0 - 17-04-2023
+
+### Added
+
+- add new fields to Definition:
+  - Security
+  - Tags
+  - Summary
+  - Description
+  - Deprecated
+  - Extensions
+
+### Updated
+
+- update kin-openapi to 0.114.0: this change removes components from exposed oas (if not manually set). In this update of kin-openapi, there is a breaking change with the T struct, which now accepts component as pointer.
+
+## 0.8.0 - 23-12-2022
+
+### BREAKING CHANGES
+
+- add `TransformPathToOasPath(path string) string` method to apirouter.Router interface to handle different types of paths parameters. If you use one of the supported routers, you should do nothing;
+
+## 0.7.0 - 22-12-2022
+
+This is a big major release. The main achievement is to increase the usability of this library to all the routers.
+Below are listed the breaking changes you should care when update the version.
+
+### BREAKING CHANGES
+
+- `apirouter.NewGorillaMuxRouter` is now `gorilla.NewRouter` (exposed by package `github.com/davidebianchi/gswagger/support/gorilla`).
+- removed `apirouter.HandlerFunc`. Now it is exposed by `gorilla.HandlerFunc`
+- changed `apirouter.Router` interface:
+  - now it accept a generics `HandlerFunc` to define the handler function
+  - add method `SwaggerHandler(contentType string, json []byte) HandlerFunc`
+- `NewRouter` function now accept `HandlerFunc` as generics
+- drop support to golang <= 1.17
+- `GenerateAndExposeSwagger` renamed to `GenerateAndExposeOpenapi`
+
+### Feature
+
+- support to different types of routers
+- add [fiber](https://github.com/gofiber/fiber) support
+- add [echo](https://echo.labstack.com/) support
+
 ## 0.6.1 - 17-11-2022
 
 ### Changed

README.md

@@ -11,11 +11,13 @@
 
 Generate an openapi spec dynamically based on the types used to handle request and response.
 
-It works with any router which support handler net/http HandlerFunc compatible.
+It works with any router, it is simple to add support to your router implementing the [apirouter](apirouter/router.go) interface.
 
 The routers supported out of the box are:
 
 - [gorilla-mux](https://github.com/gorilla/mux)
+- [fiber](https://github.com/gofiber/fiber)
+- [echo](https://echo.labstack.com/)
 
 This lib uses [kin-openapi] to automatically generate and serve a swagger file.
 
@@ -23,9 +25,15 @@ To convert struct to schemas, we use [jsonschema] library.
 The struct must contains the appropriate struct tags to be inserted in json schema to generate the schema dynamically.  
 It is always possible to add a totally custom swagger schema using [kin-openapi].
 
-## Usage
+## Install
 
-To add a router not handled out of the box, it must implements the [Router interface](./apirouter/router.go).
+To use it, install with
+
+```sh
+go get github.com/davidebianchi/gswagger
+```
+
+## Usage
 
 An example usage of this lib with gorilla mux:
 
@@ -33,7 +41,7 @@ An example usage of this lib with gorilla mux:
 context := context.Background()
 muxRouter := mux.NewRouter()
 
-router, err := swagger.NewRouter(apirouter.NewGorillaMuxRouter(muxRouter), swagger.Options{
+router, _ := swagger.NewRouter(gorilla.NewRouter(muxRouter), swagger.Options{
   Context: context,
   Openapi: &openapi3.T{
     Info: &openapi3.Info{
@@ -54,7 +62,6 @@ type User struct {
   Groups      []string `json:"groups,omitempty" jsonschema:"title=groups of the user,default=users"`
   Address     string   `json:"address" jsonschema:"title=user address"`
 }
-type Users []User
 type errorResponse struct {
   Message string `json:"message"`
 }
@@ -99,39 +106,32 @@ operation := swagger.NewOperation()
 operation.AddRequestBody(requestBody)
 
 router.AddRawRoute(http.MethodPost, "/cars", okHandler, operation)
+
+router.GenerateAndExposeOpenapi()
 ```
 
-This configuration will output the schema shown [here](testdata/users_employees.json).
+This configuration will output the schema shown [here](./support/gorilla/testdata/examples-users.json).
 
 ## Auto generated path params schema
 
-The path params, if not set in schema, are auto generated from the path. Currently, it is supported only the path params like `{myPath}`.
+The path params, if not set in schema, are auto generated from the path.
+The format of the path parameters depends on the router library you are using, as explained below.
 
-For example, with this use case:
+### Gorilla Mux
 
-```golang
-okHandler := func(w http.ResponseWriter, req *http.Request) {
-  w.WriteHeader(http.StatusOK)
-  w.Write([]byte("OK"))
-}
+Gorilla Mux supports the path parameters as `{someParam}`, for example as in `/users/{userId}`.
 
-_, err := router.AddRoute(http.MethodGet, "/users/{userId}", okHandler, Definitions{
-  Querystring: ParameterValue{
-    "query": {
-      Schema: &Schema{Value: ""},
-    },
-  },
-})
-require.NoError(t, err)
-
-_, err = router.AddRoute(http.MethodGet, "/cars/{carId}/drivers/{driverId}", okHandler, Definitions{})
-require.NoError(t, err)
-```
+Here is the [example test](./support/gorilla/examples_test.go).
 
 The generated oas schema will contains `userId`, `carId` and `driverId` as path params set to string.
 If only one params is set, you must specify manually all the path params.
 
-The generated file for this test case is [here](./testdata/params-autofill.json).
+The generated OAS for this test case is visible [here](./support/gorilla/testdata/examples-users.json).
+
+### Fiber
+Fiber supports the path parameters as `:someParam`, for example as in `/users/:userId`.
+
+Here is the [example test](./support/fiber/integration_test.go)
 
 ## SubRouter
 
@@ -140,7 +140,7 @@ It is possible to add a prefix to all the routes created under the specific rout
 
 It could also be useful if you need a sub router to create a group of APIs which use the same middleware (for example,this could be achieved by the SubRouter features of gorilla mux, for example).
 
-To see the SubRouter example, please see the [SubRouter test](./integration_test.go).
+To see the SubRouter example, please see the integration test of one of the supported routers.
 
 ### FAQ
 

apirouter/gorilla.go

@@ -1,17 +0,0 @@
-package apirouter
-
-import "github.com/gorilla/mux"
-
-type gorillaRouter struct {
-	router *mux.Router
-}
-
-func (r gorillaRouter) AddRoute(method string, path string, handler HandlerFunc) Route {
-	return r.router.HandleFunc(path, handler).Methods(method)
-}
-
-func NewGorillaMuxRouter(router *mux.Router) Router {
-	return gorillaRouter{
-		router: router,
-	}
-}

apirouter/router.go

@@ -1,12 +1,7 @@
 package apirouter
 
-import "net/http"
-
-// Handler is the http type handler
-type HandlerFunc func(w http.ResponseWriter, req *http.Request)
-
-type Router interface {
+type Router[HandlerFunc any, Route any] interface {
 	AddRoute(method string, path string, handler HandlerFunc) Route
+	SwaggerHandler(contentType string, blob []byte) HandlerFunc
+	TransformPathToOasPath(path string) string
 }
-
-type Route interface{}

apirouter/transformpath.go

@@ -0,0 +1,15 @@
+package apirouter
+
+import (
+	"strings"
+)
+
+func TransformPathParamsWithColon(path string) string {
+	pathParams := strings.Split(path, "/")
+	for i, param := range pathParams {
+		if strings.HasPrefix(param, ":") {
+			pathParams[i] = strings.Replace(param, ":", "{", 1) + "}"
+		}
+	}
+	return strings.Join(pathParams, "/")
+}

apirouter/transformpath_test.go

@@ -0,0 +1,59 @@
+package apirouter
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestTransformPathParamsWithColon(t *testing.T) {
+	testCases := []struct {
+		name         string
+		path         string
+		expectedPath string
+	}{
+		{
+			name:         "only /",
+			path:         "/",
+			expectedPath: "/",
+		},
+		{
+			name:         "without params",
+			path:         "/foo",
+			expectedPath: "/foo",
+		},
+		{
+			name:         "without params ending with /",
+			path:         "/foo/",
+			expectedPath: "/foo/",
+		},
+		{
+			name:         "with params",
+			path:         "/foo/:par1",
+			expectedPath: "/foo/{par1}",
+		},
+		{
+			name:         "with params ending with /",
+			path:         "/foo/:par1/",
+			expectedPath: "/foo/{par1}/",
+		},
+		{
+			name:         "with multiple params",
+			path:         "/:par1/:par2/:par3",
+			expectedPath: "/{par1}/{par2}/{par3}",
+		},
+		{
+			name:         "with multiple params ending with /",
+			path:         "/:par1/:par2/:par3/",
+			expectedPath: "/{par1}/{par2}/{par3}/",
+		},
+	}
+
+	for _, test := range testCases {
+		t.Run(test.name, func(t *testing.T) {
+			actual := TransformPathParamsWithColon(test.path)
+
+			require.Equal(t, test.expectedPath, actual)
+		})
+	}
+}

go.mod

@@ -1,35 +1,47 @@
 module github.com/davidebianchi/gswagger
 
-go 1.17
+go 1.24
 
 require (
-	github.com/getkin/kin-openapi v0.107.0
+	github.com/getkin/kin-openapi v0.131.0
 	github.com/ghodss/yaml v1.0.0
-	github.com/go-openapi/swag v0.21.1 // indirect
-	github.com/gorilla/mux v1.8.0
-	github.com/iancoleman/orderedmap v0.2.0 // indirect
-	github.com/labstack/echo/v4 v4.9.1
-	github.com/mailru/easyjson v0.7.7 // indirect
-	github.com/mia-platform/jsonschema v0.1.0
-	github.com/stretchr/testify v1.8.1
+	github.com/gofiber/fiber/v2 v2.52.5
+	github.com/gorilla/mux v1.8.1
+	github.com/invopop/jsonschema v0.12.0
+	github.com/labstack/echo/v4 v4.12.0
+	github.com/stretchr/testify v1.9.0
 )
 
 require (
+	github.com/andybalholm/brotli v1.0.5 // indirect
+	github.com/bahlo/generic-list-go v0.2.0 // indirect
+	github.com/buger/jsonparser v1.1.1 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
-	github.com/go-openapi/jsonpointer v0.19.5 // indirect
-	github.com/invopop/yaml v0.2.0 // indirect
+	github.com/go-openapi/jsonpointer v0.21.0 // indirect
+	github.com/go-openapi/swag v0.23.0 // indirect
+	github.com/google/uuid v1.5.0 // indirect
 	github.com/josharian/intern v1.0.0 // indirect
-	github.com/labstack/gommon v0.4.0 // indirect
-	github.com/mattn/go-colorable v0.1.12 // indirect
-	github.com/mattn/go-isatty v0.0.14 // indirect
+	github.com/klauspost/compress v1.17.0 // indirect
+	github.com/labstack/gommon v0.4.2 // indirect
+	github.com/mailru/easyjson v0.7.7 // indirect
+	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
+	github.com/mattn/go-runewidth v0.0.15 // indirect
 	github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826 // indirect
+	github.com/oasdiff/yaml v0.0.0-20250309154309-f31be36b4037 // indirect
+	github.com/oasdiff/yaml3 v0.0.0-20250309153720-d2182401db90 // indirect
+	github.com/perimeterx/marshmallow v1.1.5 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/rivo/uniseg v0.2.0 // indirect
 	github.com/valyala/bytebufferpool v1.0.0 // indirect
-	github.com/valyala/fasttemplate v1.2.1 // indirect
-	golang.org/x/crypto v0.0.0-20220312131142-6068a2e6cfdc // indirect
-	golang.org/x/net v0.0.0-20220225172249-27dd8689420f // indirect
-	golang.org/x/sys v0.0.0-20220310020820-b874c991c1a5 // indirect
-	golang.org/x/text v0.3.7 // indirect
+	github.com/valyala/fasthttp v1.51.0 // indirect
+	github.com/valyala/fasttemplate v1.2.2 // indirect
+	github.com/valyala/tcplisten v1.0.0 // indirect
+	github.com/wk8/go-ordered-map/v2 v2.1.8 // indirect
+	golang.org/x/crypto v0.22.0 // indirect
+	golang.org/x/net v0.24.0 // indirect
+	golang.org/x/sys v0.19.0 // indirect
+	golang.org/x/text v0.14.0 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -1,105 +1,92 @@
-github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
-github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/andybalholm/brotli v1.0.5 h1:8uQZIdzKmjc/iuPu7O2ioW48L81FgatrcpfFmiq/cCs=
+github.com/andybalholm/brotli v1.0.5/go.mod h1:fO7iG3H7G2nSZ7m0zPUDn85XEX2GTukHGRSepvi9Eig=
+github.com/bahlo/generic-list-go v0.2.0 h1:5sz/EEAK+ls5wF+NeqDpk5+iNdMDXrh3z3nPnH1Wvgk=
+github.com/bahlo/generic-list-go v0.2.0/go.mod h1:2KvAjgMlE5NNynlg/5iLrrCCZ2+5xWbdbCW3pNTGyYg=
+github.com/buger/jsonparser v1.1.1 h1:2PnMjfWD7wBILjqQbt530v576A/cAbQvEW9gGIpYMUs=
+github.com/buger/jsonparser v1.1.1/go.mod h1:6RYKKt7H4d4+iWqouImQ9R2FZql3VbhNgx27UK13J/0=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-github.com/getkin/kin-openapi v0.107.0 h1:bxhL6QArW7BXQj8NjXfIJQy680NsMKd25nwhvpCXchg=
-github.com/getkin/kin-openapi v0.107.0/go.mod h1:9Dhr+FasATJZjS4iOLvB0hkaxgYdulrNYm2e9epLWOo=
+github.com/getkin/kin-openapi v0.131.0 h1:NO2UeHnFKRYhZ8wg6Nyh5Cq7dHk4suQQr72a4pMrDxE=
+github.com/getkin/kin-openapi v0.131.0/go.mod h1:3OlG51PCYNsPByuiMB0t4fjnNlIDnaEDsjiKUV8nL58=
 github.com/ghodss/yaml v1.0.0 h1:wQHKEahhL6wmXdzwWG11gIVCkOv05bNOh+Rxn0yngAk=
 github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04=
-github.com/go-openapi/jsonpointer v0.19.5 h1:gZr+CIYByUqjcgeLXnQu2gHYQC9o73G2XUeOFYEICuY=
-github.com/go-openapi/jsonpointer v0.19.5/go.mod h1:Pl9vOtqEWErmShwVjC8pYs9cog34VGT37dQOVbmoatg=
-github.com/go-openapi/swag v0.19.5/go.mod h1:POnQmlKehdgb5mhVOsnJFsivZCEZ/vjK9gh66Z9tfKk=
-github.com/go-openapi/swag v0.21.1 h1:wm0rhTb5z7qpJRHBdPOMuY4QjVUMbF6/kwoYeRAOrKU=
-github.com/go-openapi/swag v0.21.1/go.mod h1:QYRuS/SOXUCsnplDa677K7+DxSOj6IPNl/eQntq43wQ=
-github.com/golang-jwt/jwt v3.2.2+incompatible/go.mod h1:8pz2t5EyA70fFQQSrl6XZXzqecmYZeUEB8OUGHkxJ+I=
-github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI=
-github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=
-github.com/iancoleman/orderedmap v0.0.0-20190318233801-ac98e3ecb4b0/go.mod h1:N0Wam8K1arqPXNWjMo21EXnBPOPp36vB07FNRdD2geA=
-github.com/iancoleman/orderedmap v0.2.0 h1:sq1N/TFpYH++aViPcaKjys3bDClUEU7s5B+z6jq8pNA=
-github.com/iancoleman/orderedmap v0.2.0/go.mod h1:N0Wam8K1arqPXNWjMo21EXnBPOPp36vB07FNRdD2geA=
-github.com/invopop/yaml v0.1.0/go.mod h1:2XuRLgs/ouIrW3XNzuNj7J3Nvu/Dig5MXvbCEdiBN3Q=
-github.com/invopop/yaml v0.2.0 h1:7zky/qH+O0DwAyoobXUqvVBwgBFRxKoQ/3FjcVpjTMY=
-github.com/invopop/yaml v0.2.0/go.mod h1:2XuRLgs/ouIrW3XNzuNj7J3Nvu/Dig5MXvbCEdiBN3Q=
+github.com/go-openapi/jsonpointer v0.21.0 h1:YgdVicSA9vH5RiHs9TZW5oyafXZFc6+2Vc1rr/O9oNQ=
+github.com/go-openapi/jsonpointer v0.21.0/go.mod h1:IUyH9l/+uyhIYQ/PXVA41Rexl+kOkAPDdXEYns6fzUY=
+github.com/go-openapi/swag v0.23.0 h1:vsEVJDUo2hPJ2tu0/Xc+4noaxyEffXNIs3cOULZ+GrE=
+github.com/go-openapi/swag v0.23.0/go.mod h1:esZ8ITTYEsH1V2trKHjAN8Ai7xHb8RV+YSZ577vPjgQ=
+github.com/go-test/deep v1.0.8 h1:TDsG77qcSprGbC6vTN8OuXp5g+J+b5Pcguhf7Zt61VM=
+github.com/go-test/deep v1.0.8/go.mod h1:5C2ZWiW0ErCdrYzpqxLbTX7MG14M9iiw8DgHncVwcsE=
+github.com/gofiber/fiber/v2 v2.52.5 h1:tWoP1MJQjGEe4GB5TUGOi7P2E0ZMMRx5ZTG4rT+yGMo=
+github.com/gofiber/fiber/v2 v2.52.5/go.mod h1:KEOE+cXMhXG0zHc9d8+E38hoX+ZN7bhOtgeF2oT6jrQ=
+github.com/google/uuid v1.5.0 h1:1p67kYwdtXjb0gL0BPiP1Av9wiZPo5A8z2cWkTZ+eyU=
+github.com/google/uuid v1.5.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/gorilla/mux v1.8.1 h1:TuBL49tXwgrFYWhqrNgrUNEY92u81SPhu7sTdzQEiWY=
+github.com/gorilla/mux v1.8.1/go.mod h1:AKf9I4AEqPTmMytcMc0KkNouC66V3BtZ4qD5fmWSiMQ=
+github.com/invopop/jsonschema v0.12.0 h1:6ovsNSuvn9wEQVOyc72aycBMVQFKz7cPdMJn10CvzRI=
+github.com/invopop/jsonschema v0.12.0/go.mod h1:ffZ5Km5SWWRAIN6wbDXItl95euhFz2uON45H2qjYt+0=
 github.com/josharian/intern v1.0.0 h1:vlS4z54oSdjm0bgjRigI+G1HpF+tI+9rE5LLzOg8HmY=
 github.com/josharian/intern v1.0.0/go.mod h1:5DoeVV0s6jJacbCEi61lwdGj/aVlrQvzHFFd8Hwg//Y=
-github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
-github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
-github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
+github.com/klauspost/compress v1.17.0 h1:Rnbp4K9EjcDuVuHtd0dgA4qNuv9yKDYKK1ulpJwgrqM=
+github.com/klauspost/compress v1.17.0/go.mod h1:ntbaceVETuRiXiv4DpjP66DpAtAGkEQskQzEyD//IeE=
+github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
+github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
 github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
-github.com/labstack/echo/v4 v4.9.1 h1:GliPYSpzGKlyOhqIbG8nmHBo3i1saKWFOgh41AN3b+Y=
-github.com/labstack/echo/v4 v4.9.1/go.mod h1:Pop5HLc+xoc4qhTZ1ip6C0RtP7Z+4VzRLWZZFKqbbjo=
-github.com/labstack/gommon v0.4.0 h1:y7cvthEAEbU0yHOf4axH8ZG2NH8knB9iNSoTO8dyIk8=
-github.com/labstack/gommon v0.4.0/go.mod h1:uW6kP17uPlLJsD3ijUYn3/M5bAxtlZhMI6m3MFxTMTM=
-github.com/mailru/easyjson v0.0.0-20190614124828-94de47d64c63/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc=
-github.com/mailru/easyjson v0.0.0-20190626092158-b2ccc519800e/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc=
-github.com/mailru/easyjson v0.7.6/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc=
+github.com/labstack/echo/v4 v4.12.0 h1:IKpw49IMryVB2p1a4dzwlhP1O2Tf2E0Ir/450lH+kI0=
+github.com/labstack/echo/v4 v4.12.0/go.mod h1:UP9Cr2DJXbOK3Kr9ONYzNowSh7HP0aG0ShAyycHSJvM=
+github.com/labstack/gommon v0.4.2 h1:F8qTUNXgG1+6WQmqoUWnz8WiEU60mXVVw0P4ht1WRA0=
+github.com/labstack/gommon v0.4.2/go.mod h1:QlUFxVM+SNXhDL/Z7YhocGIBYOiwB0mXm1+1bAPHPyU=
 github.com/mailru/easyjson v0.7.7 h1:UGYAvKxe3sBsEDzO8ZeWOSlIQfWFlxbzLZe7hwFURr0=
 github.com/mailru/easyjson v0.7.7/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc=
-github.com/mattn/go-colorable v0.1.11/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4=
-github.com/mattn/go-colorable v0.1.12 h1:jF+Du6AlPIjs2BiUiQlKOX0rt3SujHxPnksPKZbaA40=
-github.com/mattn/go-colorable v0.1.12/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4=
-github.com/mattn/go-isatty v0.0.14 h1:yVuAays6BHfxijgZPzw+3Zlu5yQgKGP2/hcQbHb7S9Y=
-github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94=
-github.com/mia-platform/jsonschema v0.1.0 h1:tjQf7TaYROsAqk7SXTL+44TrfKk3bSEvhRGPS51IA5Y=
-github.com/mia-platform/jsonschema v0.1.0/go.mod h1:r2DJjPA/+6S+WPnXZt1xONMvO2b4hlhfXfUYV0po/Dk=
+github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
+github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
+github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
+github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
+github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
+github.com/mattn/go-runewidth v0.0.15 h1:UNAjwbU9l54TA3KzvqLGxwWjHmMgBUVhBiTjelZgg3U=
+github.com/mattn/go-runewidth v0.0.15/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
 github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826 h1:RWengNIwukTxcDr9M+97sNutRR1RKhG96O6jWumTTnw=
 github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826/go.mod h1:TaXosZuwdSHYgviHp1DAtfrULt5eUgsSMsZf+YrPgl8=
-github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e h1:fD57ERR4JtEqsWbfPhv4DMiApHyliiK5xCTNVSPiaAs=
-github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno=
+github.com/oasdiff/yaml v0.0.0-20250309154309-f31be36b4037 h1:G7ERwszslrBzRxj//JalHPu/3yz+De2J+4aLtSRlHiY=
+github.com/oasdiff/yaml v0.0.0-20250309154309-f31be36b4037/go.mod h1:2bpvgLBZEtENV5scfDFEtB/5+1M4hkQhDQrccEJ/qGw=
+github.com/oasdiff/yaml3 v0.0.0-20250309153720-d2182401db90 h1:bQx3WeLcUWy+RletIKwUIt4x3t8n2SxavmoclizMb8c=
+github.com/oasdiff/yaml3 v0.0.0-20250309153720-d2182401db90/go.mod h1:y5+oSEHCPT/DGrS++Wc/479ERge0zTFxaF8PbGKcg2o=
+github.com/perimeterx/marshmallow v1.1.5 h1:a2LALqQ1BlHM8PZblsDdidgv1mWi1DgC2UmX50IvK2s=
+github.com/perimeterx/marshmallow v1.1.5/go.mod h1:dsXbUu8CRzfYP5a87xpp0xq9S3u0Vchtcl8we9tYaXw=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
-github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
-github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
-github.com/stretchr/testify v1.3.1-0.20190311161405-34c6fa2dc709/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
-github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
-github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
-github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
-github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
+github.com/rivo/uniseg v0.2.0 h1:S1pD9weZBuJdFmowNwbpi7BJ8TNftyUImj/0WQi72jY=
+github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
+github.com/rogpeppe/go-internal v1.12.0 h1:exVL4IDcn6na9z1rAb56Vxr+CgyK3nn3O+epU5NdKM8=
+github.com/rogpeppe/go-internal v1.12.0/go.mod h1:E+RYuTGaKKdloAfM02xzb0FW3Paa99yedzYV+kq4uf4=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+github.com/ugorji/go/codec v1.2.7 h1:YPXUKf7fYbp/y8xloBqZOw2qaVggbfwMlI8WM3wZUJ0=
+github.com/ugorji/go/codec v1.2.7/go.mod h1:WGN1fab3R1fzQlVQTkfxVtIBhWDRqOviHU95kRgeqEY=
 github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw=
 github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc=
-github.com/valyala/fasttemplate v1.2.1 h1:TVEnxayobAdVkhQfrfes2IzOB6o+z4roRkPF52WA1u4=
-github.com/valyala/fasttemplate v1.2.1/go.mod h1:KHLXt3tVN2HBp8eijSv/kGJopbvo7S+qRAEEKiv+SiQ=
-golang.org/x/crypto v0.0.0-20210817164053-32db794688a5/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
-golang.org/x/crypto v0.0.0-20220312131142-6068a2e6cfdc h1:i6Z9eOQAdM7lvsbkT3fwFNtSAAC+A59TYilFj53HW+E=
-golang.org/x/crypto v0.0.0-20220312131142-6068a2e6cfdc/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
-golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
-golang.org/x/net v0.0.0-20211015210444-4f30a5c0130f/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
-golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
-golang.org/x/net v0.0.0-20220225172249-27dd8689420f h1:oA4XRj0qtSt8Yo1Zms0CUlsT3KG69V2UGQWPBxujDmc=
-golang.org/x/net v0.0.0-20220225172249-27dd8689420f/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk=
-golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20211103235746-7861aae1554b/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20220310020820-b874c991c1a5 h1:y/woIyUBFbpQGKS0u1aHF/40WUDnek3fPOyD08H5Vng=
-golang.org/x/sys v0.0.0-20220310020820-b874c991c1a5/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
-golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
-golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
-golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
-golang.org/x/text v0.3.7 h1:olpwvP2KacW1ZWvsR7uQhoyTYvKAupfQrRGBFM352Gk=
-golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
-golang.org/x/time v0.0.0-20201208040808-7e3f01d25324/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
-golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+github.com/valyala/fasthttp v1.51.0 h1:8b30A5JlZ6C7AS81RsWjYMQmrZG6feChmgAolCl1SqA=
+github.com/valyala/fasthttp v1.51.0/go.mod h1:oI2XroL+lI7vdXyYoQk03bXBThfFl2cVdIA3Xl7cH8g=
+github.com/valyala/fasttemplate v1.2.2 h1:lxLXG0uE3Qnshl9QyaK6XJxMXlQZELvChBOCmQD0Loo=
+github.com/valyala/fasttemplate v1.2.2/go.mod h1:KHLXt3tVN2HBp8eijSv/kGJopbvo7S+qRAEEKiv+SiQ=
+github.com/valyala/tcplisten v1.0.0 h1:rBHj/Xf+E1tRGZyWIWwJDiRY0zc1Js+CV5DqwacVSA8=
+github.com/valyala/tcplisten v1.0.0/go.mod h1:T0xQ8SeCZGxckz9qRXTfG43PvQ/mcWh7FwZEA7Ioqkc=
+github.com/wk8/go-ordered-map/v2 v2.1.8 h1:5h/BUHu93oj4gIdvHHHGsScSTMijfx5PeYkE/fJgbpc=
+github.com/wk8/go-ordered-map/v2 v2.1.8/go.mod h1:5nJHM5DyteebpVlHnWMV0rPz6Zp7+xBAnxjb1X5vnTw=
+golang.org/x/crypto v0.22.0 h1:g1v0xeRhjcugydODzvb3mEM9SQ0HGp9s/nh3COQ/C30=
+golang.org/x/crypto v0.22.0/go.mod h1:vr6Su+7cTlO45qkww3VDJlzDn0ctJvRgYbC2NvXHt+M=
+golang.org/x/net v0.24.0 h1:1PcaxkF854Fu3+lvBIx5SYn9wRlBzzcnHZSiaFFAb0w=
+golang.org/x/net v0.24.0/go.mod h1:2Q7sJY5mzlzWjKtYUEXSlBWCdyaioyXzRB2RtU8KVE8=
+golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.19.0 h1:q5f1RH2jigJ1MoAWp2KTp3gm5zAGFUTarQZ5U386+4o=
+golang.org/x/sys v0.19.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
+golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f h1:BLraFXnmrev5lT+xlilqcH8XK9/i0At2xKjWk4p6zsU=
-gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
 gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
 gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
-gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
-gopkg.in/yaml.v3 v3.0.0-20200615113413-eeeca48fe776/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
-gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
-gopkg.in/yaml.v3 v3.0.0/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

integration_test.go

@@ -1,253 +0,0 @@
-package swagger_test
-
-import (
-	"context"
-	"io"
-	"net/http"
-	"net/http/httptest"
-	"testing"
-
-	swagger "github.com/davidebianchi/gswagger"
-	"github.com/davidebianchi/gswagger/apirouter"
-	"github.com/getkin/kin-openapi/openapi3"
-	"github.com/gorilla/mux"
-	"github.com/labstack/echo/v4"
-	"github.com/stretchr/testify/require"
-)
-
-const (
-	swaggerOpenapiTitle   = "test swagger title"
-	swaggerOpenapiVersion = "test swagger version"
-)
-
-func TestIntegration(t *testing.T) {
-	t.Run("router works correctly", func(t *testing.T) {
-		muxRouter, _ := setupSwagger(t)
-
-		w := httptest.NewRecorder()
-		r := httptest.NewRequest(http.MethodGet, "/hello", nil)
-
-		muxRouter.ServeHTTP(w, r)
-
-		require.Equal(t, http.StatusOK, w.Result().StatusCode)
-
-		body := readBody(t, w.Result().Body)
-		require.Equal(t, "OK", body)
-
-		t.Run("and generate swagger", func(t *testing.T) {
-			w := httptest.NewRecorder()
-			r := httptest.NewRequest(http.MethodGet, swagger.DefaultJSONDocumentationPath, nil)
-
-			muxRouter.ServeHTTP(w, r)
-
-			require.Equal(t, http.StatusOK, w.Result().StatusCode)
-
-			body := readBody(t, w.Result().Body)
-			require.Equal(t, "{\"components\":{},\"info\":{\"title\":\"test swagger title\",\"version\":\"test swagger version\"},\"openapi\":\"3.0.0\",\"paths\":{\"/hello\":{\"get\":{\"responses\":{\"default\":{\"description\":\"\"}}}}}}", body)
-		})
-	})
-
-	t.Run("router works correctly - echo", func(t *testing.T) {
-		echoRouter, _ := setupEchoSwagger(t)
-
-		w := httptest.NewRecorder()
-		r := httptest.NewRequest(http.MethodGet, "/hello", nil)
-
-		echoRouter.ServeHTTP(w, r)
-
-		require.Equal(t, http.StatusOK, w.Result().StatusCode)
-
-		body := readBody(t, w.Result().Body)
-		require.Equal(t, "OK", body)
-
-		t.Run("and generate swagger", func(t *testing.T) {
-			w := httptest.NewRecorder()
-			r := httptest.NewRequest(http.MethodGet, swagger.DefaultJSONDocumentationPath, nil)
-
-			echoRouter.ServeHTTP(w, r)
-
-			require.Equal(t, http.StatusOK, w.Result().StatusCode)
-
-			body := readBody(t, w.Result().Body)
-			require.Equal(t, "{\"components\":{},\"info\":{\"title\":\"test swagger title\",\"version\":\"test swagger version\"},\"openapi\":\"3.0.0\",\"paths\":{\"/hello\":{\"get\":{\"responses\":{\"default\":{\"description\":\"\"}}}}}}", body)
-		})
-	})
-
-	t.Run("works correctly with subrouter - handles path prefix - gorilla mux", func(t *testing.T) {
-		muxRouter, swaggerRouter := setupSwagger(t)
-
-		muxSubRouter := muxRouter.NewRoute().Subrouter()
-		subRouter, err := swaggerRouter.SubRouter(apirouter.NewGorillaMuxRouter(muxSubRouter), swagger.SubRouterOptions{
-			PathPrefix: "/prefix",
-		})
-		require.NoError(t, err)
-
-		_, err = subRouter.AddRoute(http.MethodGet, "/foo", okHandler, swagger.Definitions{})
-		require.NoError(t, err)
-
-		w := httptest.NewRecorder()
-		r := httptest.NewRequest(http.MethodGet, "/hello", nil)
-
-		muxRouter.ServeHTTP(w, r)
-
-		require.Equal(t, http.StatusOK, w.Result().StatusCode)
-
-		body := readBody(t, w.Result().Body)
-		require.Equal(t, "OK", body)
-
-		t.Run("correctly call sub router", func(t *testing.T) {
-			w := httptest.NewRecorder()
-			r := httptest.NewRequest(http.MethodGet, "/prefix/foo", nil)
-
-			muxRouter.ServeHTTP(w, r)
-
-			require.Equal(t, http.StatusOK, w.Result().StatusCode)
-
-			body := readBody(t, w.Result().Body)
-			require.Equal(t, "OK", body)
-		})
-
-		t.Run("and generate swagger", func(t *testing.T) {
-			w := httptest.NewRecorder()
-			r := httptest.NewRequest(http.MethodGet, swagger.DefaultJSONDocumentationPath, nil)
-
-			muxRouter.ServeHTTP(w, r)
-
-			require.Equal(t, http.StatusOK, w.Result().StatusCode)
-
-			body := readBody(t, w.Result().Body)
-			require.Equal(t, "{\"components\":{},\"info\":{\"title\":\"test swagger title\",\"version\":\"test swagger version\"},\"openapi\":\"3.0.0\",\"paths\":{\"/hello\":{\"get\":{\"responses\":{\"default\":{\"description\":\"\"}}}}}}", body)
-		})
-	})
-
-	t.Run("works correctly with subrouter - handles path prefix - echo", func(t *testing.T) {
-		eRouter, swaggerRouter := setupEchoSwagger(t)
-
-		subRouter, err := swaggerRouter.SubRouter(echoRouter{router: eRouter}, swagger.SubRouterOptions{
-			PathPrefix: "/prefix",
-		})
-		require.NoError(t, err)
-
-		_, err = subRouter.AddRoute(http.MethodGet, "/foo", okHandler, swagger.Definitions{})
-		require.NoError(t, err)
-
-		w := httptest.NewRecorder()
-		r := httptest.NewRequest(http.MethodGet, "/hello", nil)
-
-		eRouter.ServeHTTP(w, r)
-
-		require.Equal(t, http.StatusOK, w.Result().StatusCode)
-
-		body := readBody(t, w.Result().Body)
-		require.Equal(t, "OK", body)
-
-		t.Run("correctly call sub router", func(t *testing.T) {
-			w := httptest.NewRecorder()
-			r := httptest.NewRequest(http.MethodGet, "/prefix/foo", nil)
-
-			eRouter.ServeHTTP(w, r)
-
-			require.Equal(t, http.StatusOK, w.Result().StatusCode)
-
-			body := readBody(t, w.Result().Body)
-			require.Equal(t, "OK", body)
-		})
-
-		t.Run("and generate swagger", func(t *testing.T) {
-			w := httptest.NewRecorder()
-			r := httptest.NewRequest(http.MethodGet, swagger.DefaultJSONDocumentationPath, nil)
-
-			eRouter.ServeHTTP(w, r)
-
-			require.Equal(t, http.StatusOK, w.Result().StatusCode)
-
-			body := readBody(t, w.Result().Body)
-			require.Equal(t, "{\"components\":{},\"info\":{\"title\":\"test swagger title\",\"version\":\"test swagger version\"},\"openapi\":\"3.0.0\",\"paths\":{\"/hello\":{\"get\":{\"responses\":{\"default\":{\"description\":\"\"}}}}}}", body)
-		})
-	})
-}
-
-func readBody(t *testing.T, requestBody io.ReadCloser) string {
-	t.Helper()
-
-	body, err := io.ReadAll(requestBody)
-	require.NoError(t, err)
-
-	return string(body)
-}
-
-func setupSwagger(t *testing.T) (*mux.Router, *swagger.Router) {
-	t.Helper()
-
-	context := context.Background()
-	muxRouter := mux.NewRouter()
-
-	router, err := swagger.NewRouter(apirouter.NewGorillaMuxRouter(muxRouter), swagger.Options{
-		Context: context,
-		Openapi: &openapi3.T{
-			Info: &openapi3.Info{
-				Title:   swaggerOpenapiTitle,
-				Version: swaggerOpenapiVersion,
-			},
-		},
-	})
-	require.NoError(t, err)
-
-	operation := swagger.Operation{}
-
-	_, err = router.AddRawRoute(http.MethodGet, "/hello", okHandler, operation)
-	require.NoError(t, err)
-
-	err = router.GenerateAndExposeSwagger()
-	require.NoError(t, err)
-
-	return muxRouter, router
-}
-
-func okHandler(w http.ResponseWriter, req *http.Request) {
-	w.WriteHeader(http.StatusOK)
-	w.Write([]byte(`OK`))
-}
-
-func setupEchoSwagger(t *testing.T) (*echo.Echo, *swagger.Router) {
-	t.Helper()
-
-	context := context.Background()
-	e := echo.New()
-
-	router, err := swagger.NewRouter(echoRouter{router: e}, swagger.Options{
-		Context: context,
-		Openapi: &openapi3.T{
-			Info: &openapi3.Info{
-				Title:   swaggerOpenapiTitle,
-				Version: swaggerOpenapiVersion,
-			},
-		},
-	})
-	require.NoError(t, err)
-
-	operation := swagger.Operation{}
-
-	_, err = router.AddRawRoute(http.MethodGet, "/hello", func(w http.ResponseWriter, req *http.Request) {
-		ctx := e.NewContext(req, w)
-		echoOkHandler(ctx)
-	}, operation)
-	require.NoError(t, err)
-
-	err = router.GenerateAndExposeSwagger()
-	require.NoError(t, err)
-
-	return e, router
-}
-
-func echoOkHandler(c echo.Context) error {
-	return c.String(http.StatusOK, "OK")
-}
-
-type echoRouter struct {
-	router *echo.Echo
-}
-
-func (r echoRouter) AddRoute(method, path string, handler apirouter.HandlerFunc) apirouter.Route {
-	return r.router.Add(method, path, echo.WrapHandler(http.HandlerFunc(handler)))
-}

main.go

@@ -13,25 +13,30 @@ import (
 )
 
 var (
-	// ErrGenerateSwagger throws when fails the marshalling of the swagger struct.
-	ErrGenerateSwagger = errors.New("fail to generate swagger")
-	// ErrValidatingSwagger throws when given swagger params are not correct.
-	ErrValidatingSwagger = errors.New("fails to validate swagger")
+	// ErrGenerateOAS throws when fails the marshalling of the swagger struct.
+	ErrGenerateOAS = errors.New("fail to generate openapi")
+	// ErrValidatingOAS throws when given openapi params are not correct.
+	ErrValidatingOAS = errors.New("fails to validate openapi")
+
+	// Deprecated: ErrGenerateSwagger has been deprecated, use ErrGenerateOAS instead.
+	ErrGenerateSwagger = ErrGenerateOAS
+	// Deprecated: ErrValidatingSwagger has been deprecated, use ErrValidatingOAS instead.
+	ErrValidatingSwagger = ErrValidatingOAS
 )
 
 const (
-	// DefaultJSONDocumentationPath is the path of the swagger documentation in json format.
+	// DefaultJSONDocumentationPath is the path of the openapi documentation in json format.
 	DefaultJSONDocumentationPath = "/documentation/json"
-	// DefaultYAMLDocumentationPath is the path of the swagger documentation in yaml format.
+	// DefaultYAMLDocumentationPath is the path of the openapi documentation in yaml format.
 	DefaultYAMLDocumentationPath = "/documentation/yaml"
 	defaultOpenapiVersion        = "3.0.0"
 )
 
-// Router handle the api router and the swagger schema.
+// Router handle the api router and the openapi schema.
 // api router supported out of the box are:
 // - gorilla mux
-type Router struct {
-	router                apirouter.Router
+type Router[HandlerFunc, Route any] struct {
+	router                apirouter.Router[HandlerFunc, Route]
 	swaggerSchema         *openapi3.T
 	context               context.Context
 	jsonDocumentationPath string
@@ -51,11 +56,11 @@ type Options struct {
 	PathPrefix string
 }
 
-// NewRouter generate new router with swagger. Default to OpenAPI 3.0.0
-func NewRouter(router apirouter.Router, options Options) (*Router, error) {
-	swagger, err := generateNewValidSwagger(options.Openapi)
+// NewRouter generate new router with openapi. Default to OpenAPI 3.0.0
+func NewRouter[HandlerFunc, Route any](router apirouter.Router[HandlerFunc, Route], options Options) (*Router[HandlerFunc, Route], error) {
+	openapi, err := generateNewValidOpenapi(options.Openapi)
 	if err != nil {
-		return nil, fmt.Errorf("%w: %s", ErrValidatingSwagger, err)
+		return nil, fmt.Errorf("%w: %s", ErrValidatingOAS, err)
 	}
 
 	var ctx = options.Context
@@ -79,9 +84,9 @@ func NewRouter(router apirouter.Router, options Options) (*Router, error) {
 		jsonDocumentationPath = options.JSONDocumentationPath
 	}
 
-	return &Router{
+	return &Router[HandlerFunc, Route]{
 		router:                router,
-		swaggerSchema:         swagger,
+		swaggerSchema:         openapi,
 		context:               ctx,
 		yamlDocumentationPath: yamlDocumentationPath,
 		jsonDocumentationPath: jsonDocumentationPath,
@@ -93,8 +98,8 @@ type SubRouterOptions struct {
 	PathPrefix string
 }
 
-func (r Router) SubRouter(router apirouter.Router, opts SubRouterOptions) (*Router, error) {
-	return &Router{
+func (r Router[HandlerFunc, Route]) SubRouter(router apirouter.Router[HandlerFunc, Route], opts SubRouterOptions) (*Router[HandlerFunc, Route], error) {
+	return &Router[HandlerFunc, Route]{
 		router:                router,
 		swaggerSchema:         r.swaggerSchema,
 		context:               r.context,
@@ -104,56 +109,48 @@ func (r Router) SubRouter(router apirouter.Router, opts SubRouterOptions) (*Rout
 	}, nil
 }
 
-func generateNewValidSwagger(swagger *openapi3.T) (*openapi3.T, error) {
-	if swagger == nil {
-		return nil, fmt.Errorf("swagger is required")
+func generateNewValidOpenapi(openapi *openapi3.T) (*openapi3.T, error) {
+	if openapi == nil {
+		return nil, fmt.Errorf("openapi is required")
 	}
-	if swagger.OpenAPI == "" {
-		swagger.OpenAPI = defaultOpenapiVersion
+	if openapi.OpenAPI == "" {
+		openapi.OpenAPI = defaultOpenapiVersion
 	}
-	if swagger.Paths == nil {
-		swagger.Paths = openapi3.Paths{}
+	if openapi.Paths == nil {
+		openapi.Paths = &openapi3.Paths{}
 	}
 
-	if swagger.Info == nil {
-		return nil, fmt.Errorf("swagger info is required")
+	if openapi.Info == nil {
+		return nil, fmt.Errorf("openapi info is required")
 	}
-	if swagger.Info.Title == "" {
-		return nil, fmt.Errorf("swagger info title is required")
+	if openapi.Info.Title == "" {
+		return nil, fmt.Errorf("openapi info title is required")
 	}
-	if swagger.Info.Version == "" {
-		return nil, fmt.Errorf("swagger info version is required")
+	if openapi.Info.Version == "" {
+		return nil, fmt.Errorf("openapi info version is required")
 	}
 
-	return swagger, nil
+	return openapi, nil
 }
 
-// GenerateAndExposeSwagger creates a /documentation/json route on router and
+// GenerateAndExposeOpenapi creates a /documentation/json route on router and
 // expose the generated swagger
-func (r Router) GenerateAndExposeSwagger() error {
+func (r Router[_, _]) GenerateAndExposeOpenapi() error {
 	if err := r.swaggerSchema.Validate(r.context); err != nil {
-		return fmt.Errorf("%w: %s", ErrValidatingSwagger, err)
+		return fmt.Errorf("%w: %s", ErrValidatingOAS, err)
 	}
 
 	jsonSwagger, err := r.swaggerSchema.MarshalJSON()
 	if err != nil {
-		return fmt.Errorf("%w json marshal: %s", ErrGenerateSwagger, err)
+		return fmt.Errorf("%w json marshal: %s", ErrGenerateOAS, err)
 	}
-	r.router.AddRoute(http.MethodGet, r.jsonDocumentationPath, func(w http.ResponseWriter, req *http.Request) {
-		w.Header().Set("Content-Type", "application/json")
-		w.WriteHeader(http.StatusOK)
-		w.Write(jsonSwagger)
-	})
+	r.router.AddRoute(http.MethodGet, r.jsonDocumentationPath, r.router.SwaggerHandler("application/json", jsonSwagger))
 
 	yamlSwagger, err := yaml.JSONToYAML(jsonSwagger)
 	if err != nil {
-		return fmt.Errorf("%w yaml marshal: %s", ErrGenerateSwagger, err)
+		return fmt.Errorf("%w yaml marshal: %s", ErrGenerateOAS, err)
 	}
-	r.router.AddRoute(http.MethodGet, r.yamlDocumentationPath, func(w http.ResponseWriter, req *http.Request) {
-		w.Header().Set("Content-Type", "text/plain")
-		w.WriteHeader(http.StatusOK)
-		w.Write(yamlSwagger)
-	})
+	r.router.AddRoute(http.MethodGet, r.yamlDocumentationPath, r.router.SwaggerHandler("text/plain", yamlSwagger))
 
 	return nil
 }

main_test.go

@@ -10,7 +10,7 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/davidebianchi/gswagger/apirouter"
+	"github.com/davidebianchi/gswagger/support/gorilla"
 	"github.com/getkin/kin-openapi/openapi3"
 	"github.com/gorilla/mux"
 	"github.com/stretchr/testify/require"
@@ -18,7 +18,7 @@ import (
 
 func TestNewRouter(t *testing.T) {
 	muxRouter := mux.NewRouter()
-	mAPIRouter := apirouter.NewGorillaMuxRouter(muxRouter)
+	mAPIRouter := gorilla.NewRouter(muxRouter)
 
 	info := &openapi3.Info{
 		Title:   "my title",
@@ -26,14 +26,14 @@ func TestNewRouter(t *testing.T) {
 	}
 	openapi := &openapi3.T{
 		Info:  info,
-		Paths: openapi3.Paths{},
+		Paths: &openapi3.Paths{},
 	}
 
 	t.Run("not ok - invalid Openapi option", func(t *testing.T) {
 		r, err := NewRouter(mAPIRouter, Options{})
 
 		require.Nil(t, r)
-		require.EqualError(t, err, fmt.Sprintf("%s: swagger is required", ErrValidatingSwagger))
+		require.EqualError(t, err, fmt.Sprintf("%s: openapi is required", ErrValidatingOAS))
 	})
 
 	t.Run("ok - with default context", func(t *testing.T) {
@@ -42,7 +42,7 @@ func TestNewRouter(t *testing.T) {
 		})
 
 		require.NoError(t, err)
-		require.Equal(t, &Router{
+		require.Equal(t, &Router[gorilla.HandlerFunc, gorilla.Route]{
 			context:               context.Background(),
 			router:                mAPIRouter,
 			swaggerSchema:         openapi,
@@ -60,7 +60,7 @@ func TestNewRouter(t *testing.T) {
 		})
 
 		require.NoError(t, err)
-		require.Equal(t, &Router{
+		require.Equal(t, &Router[gorilla.HandlerFunc, gorilla.Route]{
 			context:               ctx,
 			router:                mAPIRouter,
 			swaggerSchema:         openapi,
@@ -80,7 +80,7 @@ func TestNewRouter(t *testing.T) {
 		})
 
 		require.NoError(t, err)
-		require.Equal(t, &Router{
+		require.Equal(t, &Router[gorilla.HandlerFunc, gorilla.Route]{
 			context:               ctx,
 			router:                mAPIRouter,
 			swaggerSchema:         openapi,
@@ -119,50 +119,50 @@ func TestNewRouter(t *testing.T) {
 }
 
 func TestGenerateValidSwagger(t *testing.T) {
-	t.Run("not ok - empty swagger info", func(t *testing.T) {
-		swagger := &openapi3.T{}
+	t.Run("not ok - empty openapi info", func(t *testing.T) {
+		openapi := &openapi3.T{}
 
-		swagger, err := generateNewValidSwagger(swagger)
-		require.Nil(t, swagger)
-		require.EqualError(t, err, "swagger info is required")
+		openapi, err := generateNewValidOpenapi(openapi)
+		require.Nil(t, openapi)
+		require.EqualError(t, err, "openapi info is required")
 	})
 
 	t.Run("not ok - empty info title", func(t *testing.T) {
-		swagger := &openapi3.T{
+		openapi := &openapi3.T{
 			Info: &openapi3.Info{},
 		}
 
-		swagger, err := generateNewValidSwagger(swagger)
-		require.Nil(t, swagger)
-		require.EqualError(t, err, "swagger info title is required")
+		openapi, err := generateNewValidOpenapi(openapi)
+		require.Nil(t, openapi)
+		require.EqualError(t, err, "openapi info title is required")
 	})
 
 	t.Run("not ok - empty info version", func(t *testing.T) {
-		swagger := &openapi3.T{
+		openapi := &openapi3.T{
 			Info: &openapi3.Info{
 				Title: "title",
 			},
 		}
 
-		swagger, err := generateNewValidSwagger(swagger)
-		require.Nil(t, swagger)
-		require.EqualError(t, err, "swagger info version is required")
+		openapi, err := generateNewValidOpenapi(openapi)
+		require.Nil(t, openapi)
+		require.EqualError(t, err, "openapi info version is required")
 	})
 
-	t.Run("ok - custom swagger", func(t *testing.T) {
-		swagger := &openapi3.T{
+	t.Run("ok - custom openapi", func(t *testing.T) {
+		openapi := &openapi3.T{
 			Info: &openapi3.Info{},
 		}
 
-		swagger, err := generateNewValidSwagger(swagger)
-		require.Nil(t, swagger)
-		require.EqualError(t, err, "swagger info title is required")
+		openapi, err := generateNewValidOpenapi(openapi)
+		require.Nil(t, openapi)
+		require.EqualError(t, err, "openapi info title is required")
 	})
 
-	t.Run("not ok - swagger is required", func(t *testing.T) {
-		swagger, err := generateNewValidSwagger(nil)
-		require.Nil(t, swagger)
-		require.EqualError(t, err, "swagger is required")
+	t.Run("not ok - openapi is required", func(t *testing.T) {
+		openapi, err := generateNewValidOpenapi(nil)
+		require.Nil(t, openapi)
+		require.EqualError(t, err, "openapi is required")
 	})
 
 	t.Run("ok", func(t *testing.T) {
@@ -170,30 +170,30 @@ func TestGenerateValidSwagger(t *testing.T) {
 			Title:   "my title",
 			Version: "my version",
 		}
-		swagger := &openapi3.T{
+		openapi := &openapi3.T{
 			Info: info,
 		}
 
-		swagger, err := generateNewValidSwagger(swagger)
+		openapi, err := generateNewValidOpenapi(openapi)
 		require.NoError(t, err)
 		require.Equal(t, &openapi3.T{
 			OpenAPI: defaultOpenapiVersion,
 			Info:    info,
-			Paths:   openapi3.Paths{},
-		}, swagger)
+			Paths:   &openapi3.Paths{},
+		}, openapi)
 	})
 }
 
 func TestGenerateAndExposeSwagger(t *testing.T) {
-	t.Run("fails swagger validation", func(t *testing.T) {
+	t.Run("fails openapi validation", func(t *testing.T) {
 		mRouter := mux.NewRouter()
-		router, err := NewRouter(apirouter.NewGorillaMuxRouter(mRouter), Options{
+		router, err := NewRouter(gorilla.NewRouter(mRouter), Options{
 			Openapi: &openapi3.T{
 				Info: &openapi3.Info{
 					Title:   "title",
 					Version: "version",
 				},
-				Components: openapi3.Components{
+				Components: &openapi3.Components{
 					Schemas: map[string]*openapi3.SchemaRef{
 						"&%": {},
 					},
@@ -202,23 +202,23 @@ func TestGenerateAndExposeSwagger(t *testing.T) {
 		})
 		require.NoError(t, err)
 
-		err = router.GenerateAndExposeSwagger()
+		err = router.GenerateAndExposeOpenapi()
 		require.Error(t, err)
-		require.True(t, strings.HasPrefix(err.Error(), fmt.Sprintf("%s:", ErrValidatingSwagger)))
+		require.True(t, strings.HasPrefix(err.Error(), fmt.Sprintf("%s:", ErrValidatingOAS)))
 	})
 
-	t.Run("correctly expose json documentation from loaded swagger file", func(t *testing.T) {
+	t.Run("correctly expose json documentation from loaded openapi file", func(t *testing.T) {
 		mRouter := mux.NewRouter()
 
-		swagger, err := openapi3.NewLoader().LoadFromFile("testdata/users_employees.json")
+		openapi, err := openapi3.NewLoader().LoadFromFile("testdata/users_employees.json")
 		require.NoError(t, err)
 
-		router, err := NewRouter(apirouter.NewGorillaMuxRouter(mRouter), Options{
-			Openapi: swagger,
+		router, err := NewRouter(gorilla.NewRouter(mRouter), Options{
+			Openapi: openapi,
 		})
 		require.NoError(t, err)
 
-		err = router.GenerateAndExposeSwagger()
+		err = router.GenerateAndExposeOpenapi()
 		require.NoError(t, err)
 
 		w := httptest.NewRecorder()
@@ -234,19 +234,19 @@ func TestGenerateAndExposeSwagger(t *testing.T) {
 		require.JSONEq(t, string(actual), body)
 	})
 
-	t.Run("correctly expose json documentation from loaded swagger file - custom path", func(t *testing.T) {
+	t.Run("correctly expose json documentation from loaded openapi file - custom path", func(t *testing.T) {
 		mRouter := mux.NewRouter()
 
-		swagger, err := openapi3.NewLoader().LoadFromFile("testdata/users_employees.json")
+		openapi, err := openapi3.NewLoader().LoadFromFile("testdata/users_employees.json")
 		require.NoError(t, err)
 
-		router, err := NewRouter(apirouter.NewGorillaMuxRouter(mRouter), Options{
-			Openapi:               swagger,
+		router, err := NewRouter(gorilla.NewRouter(mRouter), Options{
+			Openapi:               openapi,
 			JSONDocumentationPath: "/custom/path",
 		})
 		require.NoError(t, err)
 
-		err = router.GenerateAndExposeSwagger()
+		err = router.GenerateAndExposeOpenapi()
 		require.NoError(t, err)
 
 		w := httptest.NewRecorder()
@@ -262,18 +262,18 @@ func TestGenerateAndExposeSwagger(t *testing.T) {
 		require.JSONEq(t, string(actual), body)
 	})
 
-	t.Run("correctly expose yaml documentation from loaded swagger file", func(t *testing.T) {
+	t.Run("correctly expose yaml documentation from loaded openapi file", func(t *testing.T) {
 		mRouter := mux.NewRouter()
 
-		swagger, err := openapi3.NewLoader().LoadFromFile("testdata/users_employees.json")
+		openapi, err := openapi3.NewLoader().LoadFromFile("testdata/users_employees.json")
 		require.NoError(t, err)
 
-		router, err := NewRouter(apirouter.NewGorillaMuxRouter(mRouter), Options{
-			Openapi: swagger,
+		router, err := NewRouter(gorilla.NewRouter(mRouter), Options{
+			Openapi: openapi,
 		})
 		require.NoError(t, err)
 
-		err = router.GenerateAndExposeSwagger()
+		err = router.GenerateAndExposeOpenapi()
 		require.NoError(t, err)
 
 		w := httptest.NewRecorder()
@@ -289,19 +289,19 @@ func TestGenerateAndExposeSwagger(t *testing.T) {
 		require.YAMLEq(t, string(expected), body, string(body))
 	})
 
-	t.Run("correctly expose yaml documentation from loaded swagger file - custom path", func(t *testing.T) {
+	t.Run("correctly expose yaml documentation from loaded openapi file - custom path", func(t *testing.T) {
 		mRouter := mux.NewRouter()
 
-		swagger, err := openapi3.NewLoader().LoadFromFile("testdata/users_employees.json")
+		openapi, err := openapi3.NewLoader().LoadFromFile("testdata/users_employees.json")
 		require.NoError(t, err)
 
-		router, err := NewRouter(apirouter.NewGorillaMuxRouter(mRouter), Options{
-			Openapi:               swagger,
+		router, err := NewRouter(gorilla.NewRouter(mRouter), Options{
+			Openapi:               openapi,
 			YAMLDocumentationPath: "/custom/path",
 		})
 		require.NoError(t, err)
 
-		err = router.GenerateAndExposeSwagger()
+		err = router.GenerateAndExposeOpenapi()
 		require.NoError(t, err)
 
 		w := httptest.NewRecorder()
@@ -320,11 +320,11 @@ func TestGenerateAndExposeSwagger(t *testing.T) {
 	t.Run("ok - subrouter", func(t *testing.T) {
 		mRouter := mux.NewRouter()
 
-		router, err := NewRouter(apirouter.NewGorillaMuxRouter(mRouter), Options{
+		router, err := NewRouter(gorilla.NewRouter(mRouter), Options{
 			Openapi: &openapi3.T{
 				Info: &openapi3.Info{
-					Title:   "test swagger title",
-					Version: "test swagger version",
+					Title:   "test openapi title",
+					Version: "test openapi version",
 				},
 			},
 			JSONDocumentationPath: "/custom/path",
@@ -336,8 +336,8 @@ func TestGenerateAndExposeSwagger(t *testing.T) {
 			w.Write([]byte("ok"))
 		}, Definitions{})
 
-		mSubRouter := mRouter.PathPrefix("/prefix").Subrouter()
-		subrouter, err := router.SubRouter(apirouter.NewGorillaMuxRouter(mSubRouter), SubRouterOptions{
+		mSubRouter := mRouter.NewRoute().Subrouter()
+		subrouter, err := router.SubRouter(gorilla.NewRouter(mSubRouter), SubRouterOptions{
 			PathPrefix: "/prefix",
 		})
 		require.NoError(t, err)
@@ -356,7 +356,7 @@ func TestGenerateAndExposeSwagger(t *testing.T) {
 			require.NoError(t, err)
 		})
 
-		err = router.GenerateAndExposeSwagger()
+		err = router.GenerateAndExposeOpenapi()
 		require.NoError(t, err)
 
 		w := httptest.NewRecorder()
@@ -370,16 +370,40 @@ func TestGenerateAndExposeSwagger(t *testing.T) {
 		actual, err := os.ReadFile("testdata/subrouter.json")
 		require.NoError(t, err)
 		require.JSONEq(t, string(actual), body)
+
+		t.Run("test request /prefix", func(t *testing.T) {
+			w := httptest.NewRecorder()
+			req := httptest.NewRequest(http.MethodGet, "/prefix", nil)
+			mRouter.ServeHTTP(w, req)
+
+			require.Equal(t, http.StatusOK, w.Result().StatusCode)
+		})
+
+		t.Run("test request /prefix/taz", func(t *testing.T) {
+			w := httptest.NewRecorder()
+			req := httptest.NewRequest(http.MethodGet, "/prefix/taz", nil)
+			mRouter.ServeHTTP(w, req)
+
+			require.Equal(t, http.StatusOK, w.Result().StatusCode)
+		})
+
+		t.Run("test request /foo", func(t *testing.T) {
+			w := httptest.NewRecorder()
+			req := httptest.NewRequest(http.MethodGet, "/foo", nil)
+			mRouter.ServeHTTP(w, req)
+
+			require.Equal(t, http.StatusOK, w.Result().StatusCode)
+		})
 	})
 
 	t.Run("ok - new router with path prefix", func(t *testing.T) {
 		mRouter := mux.NewRouter()
 
-		router, err := NewRouter(apirouter.NewGorillaMuxRouter(mRouter), Options{
+		router, err := NewRouter(gorilla.NewRouter(mRouter), Options{
 			Openapi: &openapi3.T{
 				Info: &openapi3.Info{
-					Title:   "test swagger title",
-					Version: "test swagger version",
+					Title:   "test openapi title",
+					Version: "test openapi version",
 				},
 			},
 			JSONDocumentationPath: "/custom/path",
@@ -392,7 +416,7 @@ func TestGenerateAndExposeSwagger(t *testing.T) {
 			w.Write([]byte("ok"))
 		}, Definitions{})
 
-		err = router.GenerateAndExposeSwagger()
+		err = router.GenerateAndExposeOpenapi()
 		require.NoError(t, err)
 
 		w := httptest.NewRecorder()
@@ -405,7 +429,7 @@ func TestGenerateAndExposeSwagger(t *testing.T) {
 		body := readBody(t, w.Result().Body)
 		actual, err := os.ReadFile("testdata/router_with_prefix.json")
 		require.NoError(t, err)
-		require.JSONEq(t, string(actual), body)
+		require.JSONEq(t, string(actual), body, body)
 	})
 }
 

operation.go

@@ -28,7 +28,7 @@ func (o *Operation) AddRequestBody(requestBody *openapi3.RequestBody) {
 // but it is always possible to add it manually.
 func (o *Operation) AddResponse(status int, response *openapi3.Response) {
 	if o.Responses == nil {
-		o.Responses = make(openapi3.Responses)
+		o.Responses = &openapi3.Responses{}
 	}
 	if response.Description == nil {
 		// a description is required by kin openapi, so we set an empty description
@@ -37,3 +37,12 @@ func (o *Operation) AddResponse(status int, response *openapi3.Response) {
 	}
 	o.Operation.AddResponse(status, response)
 }
+
+func (o *Operation) addSecurityRequirements(securityRequirements SecurityRequirements) {
+	if securityRequirements != nil && o.Security == nil {
+		o.Security = openapi3.NewSecurityRequirements()
+	}
+	for _, securityRequirement := range securityRequirements {
+		o.Security.With(openapi3.SecurityRequirement(securityRequirement))
+	}
+}

operation_test.go

@@ -27,7 +27,7 @@ func TestNewOperation(t *testing.T) {
 				operation.Responses = openapi3.NewResponses()
 				return operation
 			},
-			expectedJSON: `{"components":{},"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":""}}}}}}`,
+			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":""}}}}}}`,
 		},
 		{
 			name: "add response",
@@ -36,19 +36,19 @@ func TestNewOperation(t *testing.T) {
 				operation.AddResponse(200, response)
 				return operation
 			},
-			expectedJSON: `{"components":{},"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":""}}}}}}`,
+			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":""}}}}}}`,
 		},
 	}
 
 	for _, test := range tests {
 		t.Run(test.name, func(t *testing.T) {
-			swagger := getBaseSwagger(t)
-			swagger.OpenAPI = "3.0.0"
+			openapi := getBaseSwagger(t)
+			openapi.OpenAPI = "3.0.0"
 			operation := test.getOperation(t, NewOperation())
 
-			swagger.AddOperation("/", http.MethodPost, operation.Operation)
+			openapi.AddOperation("/", http.MethodPost, operation.Operation)
 
-			data, _ := swagger.MarshalJSON()
+			data, _ := openapi.MarshalJSON()
 			jsonData := string(data)
 			require.JSONEq(t, test.expectedJSON, jsonData, "actual json data: %s", jsonData)
 		})

route.go

@@ -4,12 +4,12 @@ import (
 	"errors"
 	"fmt"
 	"path"
+	"regexp"
 	"sort"
 	"strings"
 
-	"github.com/davidebianchi/gswagger/apirouter"
 	"github.com/getkin/kin-openapi/openapi3"
-	"github.com/mia-platform/jsonschema"
+	"github.com/invopop/jsonschema"
 )
 
 var (
@@ -24,13 +24,13 @@ var (
 )
 
 // AddRawRoute add route to router with specific method, path and handler. Add the
-// router also to the swagger schema, after validating it
-func (r Router) AddRawRoute(method string, routePath string, handler apirouter.HandlerFunc, operation Operation) (interface{}, error) {
+// router also to the openapi schema, after validating it
+func (r Router[HandlerFunc, Route]) AddRawRoute(method string, routePath string, handler HandlerFunc, operation Operation) (Route, error) {
 	op := operation.Operation
 	if op != nil {
 		err := operation.Validate(r.context)
 		if err != nil {
-			return nil, err
+			return getZero[Route](), err
 		}
 	} else {
 		op = openapi3.NewOperation()
@@ -39,7 +39,8 @@ func (r Router) AddRawRoute(method string, routePath string, handler apirouter.H
 		}
 	}
 	pathWithPrefix := path.Join(r.pathPrefix, routePath)
-	r.swaggerSchema.AddOperation(pathWithPrefix, method, op)
+	oasPath := r.router.TransformPathToOasPath(pathWithPrefix)
+	r.swaggerSchema.AddOperation(oasPath, method, op)
 
 	// Handle, when content-type is json, the request/response marshalling? Maybe with a specific option.
 	return r.router.AddRoute(method, pathWithPrefix, handler), nil
@@ -71,15 +72,42 @@ type ContentValue struct {
 	Description string
 }
 
+type SecurityRequirements []SecurityRequirement
+type SecurityRequirement map[string][]string
+
 // Definitions of the route.
+// To see how to use, refer to https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
 type Definitions struct {
+	// Specification extensions https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#specification-extensions
+	Extensions map[string]interface{}
+	// Optional field for documentation
 	Tags        []string
+	Summary     string
+	Description string
+	Deprecated  bool
+
+	// PathParams contains the path parameters. If empty is autocompleted from the path
 	PathParams  ParameterValue
 	Querystring ParameterValue
 	Headers     ParameterValue
 	Cookies     ParameterValue
 	RequestBody *ContentValue
 	Responses   map[int]ContentValue
+
+	Security SecurityRequirements
+}
+
+func newOperationFromDefinition(schema Definitions) Operation {
+	operation := NewOperation()
+	operation.Responses = &openapi3.Responses{}
+	operation.Tags = schema.Tags
+	operation.Extensions = schema.Extensions
+	operation.addSecurityRequirements(schema.Security)
+	operation.Description = schema.Description
+	operation.Summary = schema.Summary
+	operation.Deprecated = schema.Deprecated
+
+	return operation
 }
 
 const (
@@ -89,46 +117,45 @@ const (
 	cookieParamType = "cookie"
 )
 
-// AddRoute add a route with json schema inferted by passed schema.
-func (r Router) AddRoute(method string, path string, handler apirouter.HandlerFunc, schema Definitions) (interface{}, error) {
-	operation := NewOperation()
-	operation.Responses = make(openapi3.Responses)
-	operation.Tags = schema.Tags
+// AddRoute add a route with json schema inferred by passed schema.
+func (r Router[HandlerFunc, Route]) AddRoute(method string, path string, handler HandlerFunc, schema Definitions) (Route, error) {
+	operation := newOperationFromDefinition(schema)
 
 	err := r.resolveRequestBodySchema(schema.RequestBody, operation)
 	if err != nil {
-		return nil, fmt.Errorf("%w: %s", ErrRequestBody, err)
+		return getZero[Route](), fmt.Errorf("%w: %s", ErrRequestBody, err)
 	}
 
 	err = r.resolveResponsesSchema(schema.Responses, operation)
 	if err != nil {
-		return nil, fmt.Errorf("%w: %s", ErrResponses, err)
+		return getZero[Route](), fmt.Errorf("%w: %s", ErrResponses, err)
 	}
 
-	err = r.resolveParameterSchema(pathParamsType, getPathParamsAutofilled(schema, path), operation)
+	oasPath := r.router.TransformPathToOasPath(path)
+	err = r.resolveParameterSchema(pathParamsType, getPathParamsAutoComplete(schema, oasPath), operation)
 	if err != nil {
-		return nil, fmt.Errorf("%w: %s", ErrPathParams, err)
+		return getZero[Route](), fmt.Errorf("%w: %s", ErrPathParams, err)
 	}
 
 	err = r.resolveParameterSchema(queryParamType, schema.Querystring, operation)
 	if err != nil {
-		return nil, fmt.Errorf("%w: %s", ErrPathParams, err)
+		return getZero[Route](), fmt.Errorf("%w: %s", ErrPathParams, err)
 	}
 
 	err = r.resolveParameterSchema(headerParamType, schema.Headers, operation)
 	if err != nil {
-		return nil, fmt.Errorf("%w: %s", ErrPathParams, err)
+		return getZero[Route](), fmt.Errorf("%w: %s", ErrPathParams, err)
 	}
 
 	err = r.resolveParameterSchema(cookieParamType, schema.Cookies, operation)
 	if err != nil {
-		return nil, fmt.Errorf("%w: %s", ErrPathParams, err)
+		return getZero[Route](), fmt.Errorf("%w: %s", ErrPathParams, err)
 	}
 
 	return r.AddRawRoute(method, path, handler, operation)
 }
 
-func (r Router) getSchemaFromInterface(v interface{}, allowAdditionalProperties bool) (*openapi3.Schema, error) {
+func (r Router[_, _]) getSchemaFromInterface(v interface{}, allowAdditionalProperties bool) (*openapi3.Schema, error) {
 	if v == nil {
 		return &openapi3.Schema{}, nil
 	}
@@ -159,7 +186,7 @@ func (r Router) getSchemaFromInterface(v interface{}, allowAdditionalProperties
 	return schema, nil
 }
 
-func (r Router) resolveRequestBodySchema(bodySchema *ContentValue, operation Operation) error {
+func (r Router[_, _]) resolveRequestBodySchema(bodySchema *ContentValue, operation Operation) error {
 	if bodySchema == nil {
 		return nil
 	}
@@ -178,7 +205,7 @@ func (r Router) resolveRequestBodySchema(bodySchema *ContentValue, operation Ope
 	return nil
 }
 
-func (r Router) resolveResponsesSchema(responses map[int]ContentValue, operation Operation) error {
+func (r Router[_, _]) resolveResponsesSchema(responses map[int]ContentValue, operation Operation) error {
 	if responses == nil {
 		operation.Responses = openapi3.NewResponses()
 	}
@@ -197,7 +224,7 @@ func (r Router) resolveResponsesSchema(responses map[int]ContentValue, operation
 	return nil
 }
 
-func (r Router) resolveParameterSchema(paramType string, paramConfig ParameterValue, operation Operation) error {
+func (r Router[_, _]) resolveParameterSchema(paramType string, paramConfig ParameterValue, operation Operation) error {
 	var keys = make([]string, 0, len(paramConfig))
 	for k := range paramConfig {
 		keys = append(keys, k)
@@ -248,7 +275,7 @@ func (r Router) resolveParameterSchema(paramType string, paramConfig ParameterVa
 	return nil
 }
 
-func (r Router) addContentToOASSchema(content Content) (openapi3.Content, error) {
+func (r Router[_, _]) addContentToOASSchema(content Content) (openapi3.Content, error) {
 	oasContent := openapi3.NewContent()
 	for k, v := range content {
 		var err error
@@ -261,17 +288,20 @@ func (r Router) addContentToOASSchema(content Content) (openapi3.Content, error)
 	return oasContent, nil
 }
 
-func getPathParamsAutofilled(schema Definitions, path string) ParameterValue {
+func getPathParamsAutoComplete(schema Definitions, path string) ParameterValue {
 	if schema.PathParams == nil {
-		pathParams := strings.Split(path, "/")
-		for _, param := range pathParams {
-			if strings.HasPrefix(param, "{") && strings.HasSuffix(param, "}") {
-				if schema.PathParams == nil {
-					schema.PathParams = make(ParameterValue)
-				}
-				param = strings.Replace(param, "{", "", 1)
-				param = strings.Replace(param, "}", "", 1)
-				schema.PathParams[param] = Parameter{
+		re := regexp.MustCompile(`\{([^}]+)\}`)
+		segments := strings.Split(path, "/")
+		for _, segment := range segments {
+			params := re.FindAllStringSubmatch(segment, -1)
+			if len(params) == 0 {
+				continue
+			}
+			if schema.PathParams == nil {
+				schema.PathParams = make(ParameterValue)
+			}
+			for _, param := range params {
+				schema.PathParams[param[1]] = Parameter{
 					Schema: &Schema{Value: ""},
 				}
 			}
@@ -279,3 +309,8 @@ func getPathParamsAutofilled(schema Definitions, path string) ParameterValue {
 	}
 	return schema.PathParams
 }
+
+func getZero[T any]() T {
+	var result T
+	return result
+}

route_test.go

@@ -8,7 +8,7 @@ import (
 	"os"
 	"testing"
 
-	"github.com/davidebianchi/gswagger/apirouter"
+	"github.com/davidebianchi/gswagger/support/gorilla"
 	"github.com/getkin/kin-openapi/openapi3"
 	"github.com/gorilla/mux"
 	"github.com/stretchr/testify/require"
@@ -17,8 +17,9 @@ import (
 const jsonType = "application/json"
 const formDataType = "multipart/form-data"
 
-func TestAddRoutes(t *testing.T) {
+type TestRouter = Router[gorilla.HandlerFunc, gorilla.Route]
 
+func TestAddRoutes(t *testing.T) {
 	type User struct {
 		Name        string   `json:"name" jsonschema:"title=The user name,required" jsonschema_extras:"example=Jane"`
 		PhoneNumber int      `json:"phone" jsonschema:"title=mobile number of user"`
@@ -47,6 +48,7 @@ func TestAddRoutes(t *testing.T) {
 		FirstName string      `json:"firstName" jsonschema:"title=user first name"`
 		LastName  string      `json:"lastName" jsonschema:"title=user last name"`
 		Metadata  interface{} `json:"metadata,omitempty" jsonschema:"title=custom properties,oneof_type=string;number"`
+		UserType  string      `json:"userType,omitempty" jsonschema:"title=type of user,enum=simple,enum=advanced"`
 	}
 
 	okHandler := func(w http.ResponseWriter, req *http.Request) {
@@ -56,19 +58,19 @@ func TestAddRoutes(t *testing.T) {
 
 	tests := []struct {
 		name         string
-		routes       func(t *testing.T, router *Router)
+		routes       func(t *testing.T, router *TestRouter)
 		fixturesPath string
 		testPath     string
 		testMethod   string
 	}{
 		{
 			name:         "no routes",
-			routes:       func(t *testing.T, router *Router) {},
+			routes:       func(t *testing.T, router *TestRouter) {},
 			fixturesPath: "testdata/empty.json",
 		},
 		{
 			name: "empty route schema",
-			routes: func(t *testing.T, router *Router) {
+			routes: func(t *testing.T, router *TestRouter) {
 				_, err := router.AddRoute(http.MethodPost, "/", okHandler, Definitions{})
 				require.NoError(t, err)
 			},
@@ -78,7 +80,7 @@ func TestAddRoutes(t *testing.T) {
 		},
 		{
 			name: "multiple real routes",
-			routes: func(t *testing.T, router *Router) {
+			routes: func(t *testing.T, router *TestRouter) {
 				_, err := router.AddRoute(http.MethodPost, "/users", okHandler, Definitions{
 					RequestBody: &ContentValue{
 						Content: Content{
@@ -128,7 +130,7 @@ func TestAddRoutes(t *testing.T) {
 		},
 		{
 			name: "multipart request body",
-			routes: func(t *testing.T, router *Router) {
+			routes: func(t *testing.T, router *TestRouter) {
 				_, err := router.AddRoute(http.MethodPost, "/files", okHandler, Definitions{
 					RequestBody: &ContentValue{
 						Content: Content{
@@ -157,7 +159,7 @@ func TestAddRoutes(t *testing.T) {
 		},
 		{
 			name: "schema with params",
-			routes: func(t *testing.T, router *Router) {
+			routes: func(t *testing.T, router *TestRouter) {
 				var number = 0
 				_, err := router.AddRoute(http.MethodGet, "/users/{userId}", okHandler, Definitions{
 					PathParams: ParameterValue{
@@ -185,8 +187,8 @@ func TestAddRoutes(t *testing.T) {
 			fixturesPath: "testdata/params.json",
 		},
 		{
-			name: "schema without params autofilled",
-			routes: func(t *testing.T, router *Router) {
+			name: "schema without explicit params autofill them",
+			routes: func(t *testing.T, router *TestRouter) {
 				_, err := router.AddRoute(http.MethodGet, "/users/{userId}", okHandler, Definitions{
 					Querystring: ParameterValue{
 						"query": {
@@ -198,13 +200,16 @@ func TestAddRoutes(t *testing.T) {
 
 				_, err = router.AddRoute(http.MethodGet, "/cars/{carId}/drivers/{driverId}", okHandler, Definitions{})
 				require.NoError(t, err)
+
+				_, err = router.AddRoute(http.MethodGet, "/files/{name}.{extension}", okHandler, Definitions{})
+				require.NoError(t, err)
 			},
-			testPath:     "/users/12",
+			testPath:     "/files/myid.yaml",
 			fixturesPath: "testdata/params-autofill.json",
 		},
 		{
 			name: "schema with querystring",
-			routes: func(t *testing.T, router *Router) {
+			routes: func(t *testing.T, router *TestRouter) {
 				_, err := router.AddRoute(http.MethodGet, "/projects", okHandler, Definitions{
 					Querystring: ParameterValue{
 						"projectId": {
@@ -220,7 +225,7 @@ func TestAddRoutes(t *testing.T) {
 		},
 		{
 			name: "schema with headers",
-			routes: func(t *testing.T, router *Router) {
+			routes: func(t *testing.T, router *TestRouter) {
 				_, err := router.AddRoute(http.MethodGet, "/projects", okHandler, Definitions{
 					Headers: ParameterValue{
 						"foo": {
@@ -239,7 +244,7 @@ func TestAddRoutes(t *testing.T) {
 		},
 		{
 			name: "schema with cookies",
-			routes: func(t *testing.T, router *Router) {
+			routes: func(t *testing.T, router *TestRouter) {
 				_, err := router.AddRoute(http.MethodGet, "/projects", okHandler, Definitions{
 					Cookies: ParameterValue{
 						"debug": {
@@ -258,7 +263,7 @@ func TestAddRoutes(t *testing.T) {
 		},
 		{
 			name: "schema defined without value",
-			routes: func(t *testing.T, router *Router) {
+			routes: func(t *testing.T, router *TestRouter) {
 				_, err := router.AddRoute(http.MethodPost, "/{id}", okHandler, Definitions{
 					RequestBody: &ContentValue{
 						Description: "request body without schema",
@@ -287,7 +292,7 @@ func TestAddRoutes(t *testing.T) {
 		},
 		{
 			name: "allOf schema",
-			routes: func(t *testing.T, router *Router) {
+			routes: func(t *testing.T, router *TestRouter) {
 				schema := openapi3.NewAllOfSchema()
 				schema.AllOf = []*openapi3.SchemaRef{
 					{
@@ -332,7 +337,7 @@ func TestAddRoutes(t *testing.T) {
 		},
 		{
 			name: "anyOf schema",
-			routes: func(t *testing.T, router *Router) {
+			routes: func(t *testing.T, router *TestRouter) {
 				schema := openapi3.NewAnyOfSchema()
 				schema.AnyOf = []*openapi3.SchemaRef{
 					{
@@ -375,8 +380,8 @@ func TestAddRoutes(t *testing.T) {
 			fixturesPath: "testdata/anyof.json",
 		},
 		{
-			name: "oneOf support on properties",
-			routes: func(t *testing.T, router *Router) {
+			name: "oneOf and enum are supported on properties",
+			routes: func(t *testing.T, router *TestRouter) {
 				_, err := router.AddRoute(http.MethodPost, "/user-profile", okHandler, Definitions{
 					RequestBody: &ContentValue{
 						Content: Content{
@@ -424,7 +429,7 @@ func TestAddRoutes(t *testing.T) {
 		},
 		{
 			name: "schema with tags",
-			routes: func(t *testing.T, router *Router) {
+			routes: func(t *testing.T, router *TestRouter) {
 				_, err := router.AddRoute(http.MethodGet, "/users", okHandler, Definitions{
 					Tags: []string{"Tag1", "Tag2"},
 				})
@@ -433,6 +438,66 @@ func TestAddRoutes(t *testing.T) {
 			testPath:     "/users",
 			fixturesPath: "testdata/tags.json",
 		},
+		{
+			name: "schema with security",
+			routes: func(t *testing.T, router *TestRouter) {
+				_, err := router.AddRoute(http.MethodGet, "/users", okHandler, Definitions{
+					Security: SecurityRequirements{
+						SecurityRequirement{
+							"api_key": []string{},
+							"auth": []string{
+								"resource.write",
+							},
+						},
+					},
+				})
+				require.NoError(t, err)
+			},
+			testPath:     "/users",
+			fixturesPath: "testdata/security.json",
+		},
+		{
+			name: "schema with extension",
+			routes: func(t *testing.T, router *TestRouter) {
+				_, err := router.AddRoute(http.MethodGet, "/users", okHandler, Definitions{
+					Extensions: map[string]interface{}{
+						"x-extension-field": map[string]string{
+							"foo": "bar",
+						},
+					},
+				})
+				require.NoError(t, err)
+			},
+			testPath:     "/users",
+			fixturesPath: "testdata/extension.json",
+		},
+		{
+			name: "invalid extension - not starts with x-",
+			routes: func(t *testing.T, router *TestRouter) {
+				_, err := router.AddRoute(http.MethodGet, "/", okHandler, Definitions{
+					Extensions: map[string]interface{}{
+						"extension-field": map[string]string{
+							"foo": "bar",
+						},
+					},
+				})
+				require.EqualError(t, err, "extra sibling fields: [extension-field]")
+			},
+			fixturesPath: "testdata/empty.json",
+		},
+		{
+			name: "schema with summary, description, deprecated and operationID",
+			routes: func(t *testing.T, router *TestRouter) {
+				_, err := router.AddRoute(http.MethodGet, "/users", okHandler, Definitions{
+					Summary:     "small description",
+					Description: "this is the long route description",
+					Deprecated:  true,
+				})
+				require.NoError(t, err)
+			},
+			testPath:     "/users",
+			fixturesPath: "testdata/users-deprecated-with-description.json",
+		},
 	}
 
 	for _, test := range tests {
@@ -440,7 +505,7 @@ func TestAddRoutes(t *testing.T) {
 			context := context.Background()
 			r := mux.NewRouter()
 
-			router, err := NewRouter(apirouter.NewGorillaMuxRouter(r), Options{
+			router, err := NewRouter(gorilla.NewRouter(r), Options{
 				Context: context,
 				Openapi: getBaseSwagger(t),
 			})
@@ -450,7 +515,7 @@ func TestAddRoutes(t *testing.T) {
 			// Add routes to test
 			test.routes(t, router)
 
-			err = router.GenerateAndExposeSwagger()
+			err = router.GenerateAndExposeOpenapi()
 			require.NoError(t, err)
 
 			if test.testPath != "" {
@@ -468,7 +533,7 @@ func TestAddRoutes(t *testing.T) {
 				require.Equal(t, "OK", body)
 			}
 
-			t.Run("and generate swagger documentation in json", func(t *testing.T) {
+			t.Run("and generate openapi documentation in json", func(t *testing.T) {
 				w := httptest.NewRecorder()
 				req := httptest.NewRequest(http.MethodGet, DefaultJSONDocumentationPath, nil)
 
@@ -630,7 +695,7 @@ func TestResolveRequestBodySchema(t *testing.T) {
 	}
 
 	mux := mux.NewRouter()
-	router, err := NewRouter(apirouter.NewGorillaMuxRouter(mux), Options{
+	router, err := NewRouter(gorilla.NewRouter(mux), Options{
 		Openapi: getBaseSwagger(t),
 	})
 	require.NoError(t, err)
@@ -854,7 +919,7 @@ func TestResolveResponsesSchema(t *testing.T) {
 	}
 
 	mux := mux.NewRouter()
-	router, err := NewRouter(apirouter.NewGorillaMuxRouter(mux), Options{
+	router, err := NewRouter(gorilla.NewRouter(mux), Options{
 		Openapi: getBaseSwagger(t),
 	})
 	require.NoError(t, err)
@@ -862,7 +927,7 @@ func TestResolveResponsesSchema(t *testing.T) {
 	for _, test := range tests {
 		t.Run(test.name, func(t *testing.T) {
 			operation := NewOperation()
-			operation.Responses = make(openapi3.Responses)
+			operation.Responses = &openapi3.Responses{}
 
 			err := router.resolveResponsesSchema(test.responsesSchema, operation)
 
@@ -1024,7 +1089,7 @@ func TestResolveParametersSchema(t *testing.T) {
 	}
 
 	mux := mux.NewRouter()
-	router, err := NewRouter(apirouter.NewGorillaMuxRouter(mux), Options{
+	router, err := NewRouter(gorilla.NewRouter(mux), Options{
 		Openapi: getBaseSwagger(t),
 	})
 	require.NoError(t, err)
@@ -1051,8 +1116,66 @@ func getBaseSwagger(t *testing.T) *openapi3.T {
 
 	return &openapi3.T{
 		Info: &openapi3.Info{
-			Title:   "test swagger title",
-			Version: "test swagger version",
+			Title:   "test openapi title",
+			Version: "test openapi version",
 		},
 	}
 }
+
+func TestGetPathParamsAutoComplete(t *testing.T) {
+	testCases := map[string]struct {
+		schemaDefinition Definitions
+		path             string
+		expected         ParameterValue
+	}{
+		"no path params": {
+			schemaDefinition: Definitions{},
+			path:             "/users",
+			expected:         nil,
+		},
+		"with path params": {
+			schemaDefinition: Definitions{},
+			path:             "/users/{userId}",
+			expected: ParameterValue{
+				"userId": {
+					Schema: &Schema{Value: ""},
+				},
+			},
+		},
+		"with multiple path params": {
+			schemaDefinition: Definitions{},
+			path:             "/foo/{bar}.{taz}",
+			expected: ParameterValue{
+				"bar": {
+					Schema: &Schema{Value: ""},
+				},
+				"taz": {
+					Schema: &Schema{Value: ""},
+				},
+			},
+		},
+		"with nested multiple path params": {
+			schemaDefinition: Definitions{},
+			path:             "/foo/{bar}.{taz}/{baz}/ok",
+			expected: ParameterValue{
+				"bar": {
+					Schema: &Schema{Value: ""},
+				},
+				"taz": {
+					Schema: &Schema{Value: ""},
+				},
+				"baz": {
+					Schema: &Schema{Value: ""},
+				},
+			},
+		},
+	}
+
+	for name, test := range testCases {
+		t.Run(name, func(t *testing.T) {
+			actual := getPathParamsAutoComplete(test.schemaDefinition, test.path)
+
+			require.Equal(t, test.expected, actual)
+		})
+	}
+}

support/echo/echo.go

@@ -0,0 +1,36 @@
+package echo
+
+import (
+	"github.com/davidebianchi/gswagger/apirouter"
+
+	"net/http"
+
+	"github.com/labstack/echo/v4"
+)
+
+type Route = *echo.Route
+
+type echoRouter struct {
+	router *echo.Echo
+}
+
+func (r echoRouter) AddRoute(method string, path string, handler echo.HandlerFunc) Route {
+	return r.router.Add(method, path, handler)
+}
+
+func (r echoRouter) SwaggerHandler(contentType string, blob []byte) echo.HandlerFunc {
+	return func(c echo.Context) error {
+		c.Response().Header().Add("Content-Type", contentType)
+		return c.JSONBlob(http.StatusOK, blob)
+	}
+}
+
+func (r echoRouter) TransformPathToOasPath(path string) string {
+	return apirouter.TransformPathParamsWithColon(path)
+}
+
+func NewRouter(router *echo.Echo) apirouter.Router[echo.HandlerFunc, Route] {
+	return echoRouter{
+		router: router,
+	}
+}

support/echo/echo_test.go

@@ -0,0 +1,65 @@
+package echo
+
+import (
+	"io"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/davidebianchi/gswagger/apirouter"
+	"github.com/labstack/echo/v4"
+	"github.com/stretchr/testify/require"
+)
+
+func TestGorillaMuxRouter(t *testing.T) {
+	echoRouter := echo.New()
+	ar := NewRouter(echoRouter)
+
+	t.Run("create a new api router", func(t *testing.T) {
+		require.Implements(t, (*apirouter.Router[echo.HandlerFunc, Route])(nil), ar)
+	})
+
+	t.Run("add new route", func(t *testing.T) {
+		route := ar.AddRoute(http.MethodGet, "/foo", func(c echo.Context) error {
+			return c.String(http.StatusOK, "")
+		})
+		require.IsType(t, route, &echo.Route{})
+
+		t.Run("router exposes correctly api", func(t *testing.T) {
+			w := httptest.NewRecorder()
+			r := httptest.NewRequest(http.MethodGet, "/foo", nil)
+
+			echoRouter.ServeHTTP(w, r)
+
+			require.Equal(t, http.StatusOK, w.Result().StatusCode)
+		})
+
+		t.Run("router exposes api only to the specific method", func(t *testing.T) {
+			w := httptest.NewRecorder()
+			r := httptest.NewRequest(http.MethodPost, "/foo", nil)
+
+			echoRouter.ServeHTTP(w, r)
+
+			require.Equal(t, http.StatusMethodNotAllowed, w.Result().StatusCode)
+		})
+	})
+
+	t.Run("create openapi handler", func(t *testing.T) {
+		handlerFunc := ar.SwaggerHandler("text/html", []byte("some data"))
+		echoRouter.GET("/oas", handlerFunc)
+
+		t.Run("responds correctly to the API", func(t *testing.T) {
+			w := httptest.NewRecorder()
+			r := httptest.NewRequest(http.MethodGet, "/oas", nil)
+
+			echoRouter.ServeHTTP(w, r)
+
+			require.Equal(t, http.StatusOK, w.Result().StatusCode)
+			require.Equal(t, "text/html", w.Result().Header.Get("Content-Type"))
+
+			body, err := io.ReadAll(w.Result().Body)
+			require.NoError(t, err)
+			require.Equal(t, "some data", string(body))
+		})
+	})
+}

support/echo/integration_test.go

@@ -0,0 +1,170 @@
+package echo_test
+
+import (
+	"context"
+	"io"
+	"net/http"
+	"net/http/httptest"
+	"os"
+	"testing"
+
+	oasEcho "github.com/davidebianchi/gswagger/support/echo"
+
+	swagger "github.com/davidebianchi/gswagger"
+	"github.com/getkin/kin-openapi/openapi3"
+	"github.com/labstack/echo/v4"
+	"github.com/stretchr/testify/require"
+)
+
+const (
+	swaggerOpenapiTitle   = "test openapi title"
+	swaggerOpenapiVersion = "test openapi version"
+)
+
+type echoSwaggerRouter = swagger.Router[echo.HandlerFunc, *echo.Route]
+
+func TestEchoIntegration(t *testing.T) {
+	t.Run("router works correctly - echo", func(t *testing.T) {
+		echoRouter, oasRouter := setupEchoSwagger(t)
+
+		err := oasRouter.GenerateAndExposeOpenapi()
+		require.NoError(t, err)
+
+		t.Run("/hello", func(t *testing.T) {
+			w := httptest.NewRecorder()
+			r := httptest.NewRequest(http.MethodGet, "/hello", nil)
+
+			echoRouter.ServeHTTP(w, r)
+
+			require.Equal(t, http.StatusOK, w.Result().StatusCode)
+
+			body := readBody(t, w.Result().Body)
+			require.Equal(t, "OK", body)
+		})
+
+		t.Run("/hello/:value", func(t *testing.T) {
+			w := httptest.NewRecorder()
+			r := httptest.NewRequest(http.MethodPost, "/hello/something", nil)
+
+			echoRouter.ServeHTTP(w, r)
+
+			require.Equal(t, http.StatusOK, w.Result().StatusCode)
+
+			body := readBody(t, w.Result().Body)
+			require.Equal(t, "OK", body)
+		})
+
+		t.Run("and generate swagger", func(t *testing.T) {
+			w := httptest.NewRecorder()
+			r := httptest.NewRequest(http.MethodGet, swagger.DefaultJSONDocumentationPath, nil)
+
+			echoRouter.ServeHTTP(w, r)
+
+			require.Equal(t, http.StatusOK, w.Result().StatusCode)
+
+			body := readBody(t, w.Result().Body)
+			require.JSONEq(t, readFile(t, "../testdata/integration.json"), body)
+		})
+	})
+
+	t.Run("works correctly with subrouter - handles path prefix - echo", func(t *testing.T) {
+		eRouter, oasRouter := setupEchoSwagger(t)
+
+		subRouter, err := oasRouter.SubRouter(oasEcho.NewRouter(eRouter), swagger.SubRouterOptions{
+			PathPrefix: "/prefix",
+		})
+		require.NoError(t, err)
+
+		_, err = subRouter.AddRoute(http.MethodGet, "/foo", okHandler, swagger.Definitions{})
+		require.NoError(t, err)
+
+		err = oasRouter.GenerateAndExposeOpenapi()
+		require.NoError(t, err)
+
+		t.Run("correctly call /hello", func(t *testing.T) {
+			w := httptest.NewRecorder()
+			r := httptest.NewRequest(http.MethodGet, "/hello", nil)
+
+			eRouter.ServeHTTP(w, r)
+
+			require.Equal(t, http.StatusOK, w.Result().StatusCode)
+
+			body := readBody(t, w.Result().Body)
+			require.Equal(t, "OK", body)
+		})
+
+		t.Run("correctly call sub router", func(t *testing.T) {
+			w := httptest.NewRecorder()
+			r := httptest.NewRequest(http.MethodGet, "/prefix/foo", nil)
+
+			eRouter.ServeHTTP(w, r)
+
+			require.Equal(t, http.StatusOK, w.Result().StatusCode)
+
+			body := readBody(t, w.Result().Body)
+			require.Equal(t, "OK", body)
+		})
+
+		t.Run("and generate swagger", func(t *testing.T) {
+			w := httptest.NewRecorder()
+			r := httptest.NewRequest(http.MethodGet, swagger.DefaultJSONDocumentationPath, nil)
+
+			eRouter.ServeHTTP(w, r)
+
+			require.Equal(t, http.StatusOK, w.Result().StatusCode)
+
+			body := readBody(t, w.Result().Body)
+			require.JSONEq(t, readFile(t, "../testdata/intergation-subrouter.json"), body, body)
+		})
+	})
+}
+
+func readBody(t *testing.T, requestBody io.ReadCloser) string {
+	t.Helper()
+
+	body, err := io.ReadAll(requestBody)
+	require.NoError(t, err)
+
+	return string(body)
+}
+
+func setupEchoSwagger(t *testing.T) (*echo.Echo, *echoSwaggerRouter) {
+	t.Helper()
+
+	context := context.Background()
+	e := echo.New()
+
+	router, err := swagger.NewRouter(oasEcho.NewRouter(e), swagger.Options{
+		Context: context,
+		Openapi: &openapi3.T{
+			Info: &openapi3.Info{
+				Title:   swaggerOpenapiTitle,
+				Version: swaggerOpenapiVersion,
+			},
+		},
+	})
+	require.NoError(t, err)
+
+	operation := swagger.Operation{}
+
+	_, err = router.AddRawRoute(http.MethodGet, "/hello", okHandler, operation)
+	require.NoError(t, err)
+
+	_, err = router.AddRoute(http.MethodPost, "/hello/:value", okHandler, swagger.Definitions{})
+	require.NoError(t, err)
+
+	return e, router
+}
+
+func okHandler(c echo.Context) error {
+	return c.String(http.StatusOK, "OK")
+}
+
+func readFile(t *testing.T, path string) string {
+	t.Helper()
+
+	fileContent, err := os.ReadFile(path)
+	require.NoError(t, err)
+
+	return string(fileContent)
+}

support/fiber/fiber.go

@@ -0,0 +1,34 @@
+package fiber
+
+import (
+	"github.com/davidebianchi/gswagger/apirouter"
+	"github.com/gofiber/fiber/v2"
+)
+
+type HandlerFunc = fiber.Handler
+type Route = fiber.Router
+
+type fiberRouter struct {
+	router fiber.Router
+}
+
+func NewRouter(router fiber.Router) apirouter.Router[HandlerFunc, Route] {
+	return fiberRouter{
+		router: router,
+	}
+}
+
+func (r fiberRouter) AddRoute(method string, path string, handler HandlerFunc) Route {
+	return r.router.Add(method, path, handler)
+}
+
+func (r fiberRouter) SwaggerHandler(contentType string, blob []byte) HandlerFunc {
+	return func(c *fiber.Ctx) error {
+		c.Set("Content-Type", contentType)
+		return c.Send(blob)
+	}
+}
+
+func (r fiberRouter) TransformPathToOasPath(path string) string {
+	return apirouter.TransformPathParamsWithColon(path)
+}

support/fiber/fiber_test.go

@@ -0,0 +1,63 @@
+package fiber
+
+import (
+	"io"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/davidebianchi/gswagger/apirouter"
+
+	"github.com/gofiber/fiber/v2"
+	"github.com/stretchr/testify/require"
+)
+
+func TestFiberRouterSupport(t *testing.T) {
+	fiberRouter := fiber.New()
+	ar := NewRouter(fiberRouter)
+
+	t.Run("create a new api router", func(t *testing.T) {
+		require.Implements(t, (*apirouter.Router[HandlerFunc, Route])(nil), ar)
+	})
+
+	t.Run("add new route", func(t *testing.T) {
+		route := ar.AddRoute(http.MethodGet, "/foo", func(c *fiber.Ctx) error {
+			return c.SendStatus(http.StatusOK)
+		})
+		require.IsType(t, route, fiber.New())
+
+		t.Run("router exposes correctly api", func(t *testing.T) {
+			r := httptest.NewRequest(http.MethodGet, "/foo", nil)
+
+			resp, err := fiberRouter.Test(r)
+			require.NoError(t, err)
+			require.Equal(t, http.StatusOK, resp.StatusCode)
+		})
+
+		t.Run("router exposes api only to the specific method", func(t *testing.T) {
+			r := httptest.NewRequest(http.MethodPost, "/foo", nil)
+
+			resp, err := fiberRouter.Test(r)
+			require.NoError(t, err)
+			require.Equal(t, http.StatusMethodNotAllowed, resp.StatusCode)
+		})
+	})
+
+	t.Run("create openapi handler", func(t *testing.T) {
+		handlerFunc := ar.SwaggerHandler("text/html", []byte("some data"))
+		fiberRouter.Get("/oas", handlerFunc)
+
+		t.Run("responds correctly to the API", func(t *testing.T) {
+			r := httptest.NewRequest(http.MethodGet, "/oas", nil)
+
+			resp, err := fiberRouter.Test(r)
+			require.NoError(t, err)
+			require.Equal(t, http.StatusOK, resp.StatusCode)
+			require.Equal(t, "text/html", resp.Header.Get("Content-Type"))
+
+			body, err := io.ReadAll(resp.Body)
+			require.NoError(t, err)
+			require.Equal(t, "some data", string(body))
+		})
+	})
+}

support/fiber/integration_test.go

@@ -0,0 +1,165 @@
+package fiber_test
+
+import (
+	"context"
+	"io"
+	"net/http"
+	"net/http/httptest"
+	"os"
+	"testing"
+
+	swagger "github.com/davidebianchi/gswagger"
+	oasFiber "github.com/davidebianchi/gswagger/support/fiber"
+
+	"github.com/getkin/kin-openapi/openapi3"
+	"github.com/gofiber/fiber/v2"
+	"github.com/stretchr/testify/require"
+)
+
+type SwaggerRouter = swagger.Router[oasFiber.HandlerFunc, oasFiber.Route]
+
+const (
+	swaggerOpenapiTitle   = "test openapi title"
+	swaggerOpenapiVersion = "test openapi version"
+)
+
+func TestFiberIntegration(t *testing.T) {
+	t.Run("router works correctly", func(t *testing.T) {
+		router, oasRouter := setupSwagger(t)
+
+		err := oasRouter.GenerateAndExposeOpenapi()
+		require.NoError(t, err)
+
+		t.Run("/hello", func(t *testing.T) {
+			r := httptest.NewRequest(http.MethodGet, "/hello", nil)
+
+			resp, err := router.Test(r)
+			require.NoError(t, err)
+			require.Equal(t, http.StatusOK, resp.StatusCode)
+
+			body := readBody(t, resp.Body)
+			require.Equal(t, "OK", body)
+		})
+
+		t.Run("/hello/:value", func(t *testing.T) {
+			r := httptest.NewRequest(http.MethodPost, "/hello/something", nil)
+
+			resp, err := router.Test(r)
+			require.NoError(t, err)
+			require.Equal(t, http.StatusOK, resp.StatusCode)
+
+			body := readBody(t, resp.Body)
+			require.Equal(t, "OK", body)
+		})
+
+		t.Run("and generate swagger", func(t *testing.T) {
+			r := httptest.NewRequest(http.MethodGet, swagger.DefaultJSONDocumentationPath, nil)
+
+			resp, err := router.Test(r)
+			require.NoError(t, err)
+			require.Equal(t, http.StatusOK, resp.StatusCode)
+
+			body := readBody(t, resp.Body)
+			require.JSONEq(t, readFile(t, "../testdata/integration.json"), body, body)
+		})
+	})
+
+	t.Run("works correctly with subrouter - handles path prefix - gorilla mux", func(t *testing.T) {
+		fiberRouter, oasRouter := setupSwagger(t)
+
+		subRouter, err := oasRouter.SubRouter(oasFiber.NewRouter(fiberRouter), swagger.SubRouterOptions{
+			PathPrefix: "/prefix",
+		})
+		require.NoError(t, err)
+
+		_, err = subRouter.AddRoute(http.MethodGet, "/foo", okHandler, swagger.Definitions{})
+		require.NoError(t, err)
+
+		err = oasRouter.GenerateAndExposeOpenapi()
+		require.NoError(t, err)
+
+		t.Run("correctly call /hello", func(t *testing.T) {
+			r := httptest.NewRequest(http.MethodGet, "/hello", nil)
+
+			resp, err := fiberRouter.Test(r)
+			require.NoError(t, err)
+			require.Equal(t, http.StatusOK, resp.StatusCode)
+
+			body := readBody(t, resp.Body)
+			require.Equal(t, "OK", body)
+		})
+
+		t.Run("correctly call sub router", func(t *testing.T) {
+			r := httptest.NewRequest(http.MethodGet, "/prefix/foo", nil)
+
+			resp, err := fiberRouter.Test(r)
+			require.NoError(t, err)
+			require.Equal(t, http.StatusOK, resp.StatusCode)
+
+			body := readBody(t, resp.Body)
+			require.Equal(t, "OK", body)
+		})
+
+		t.Run("and generate swagger", func(t *testing.T) {
+			r := httptest.NewRequest(http.MethodGet, swagger.DefaultJSONDocumentationPath, nil)
+
+			resp, err := fiberRouter.Test(r)
+			require.NoError(t, err)
+			require.Equal(t, http.StatusOK, resp.StatusCode)
+
+			body := readBody(t, resp.Body)
+			require.JSONEq(t, readFile(t, "../testdata/intergation-subrouter.json"), body, body)
+		})
+	})
+}
+
+func setupSwagger(t *testing.T) (*fiber.App, *SwaggerRouter) {
+	t.Helper()
+
+	context := context.Background()
+	fiberRouter := fiber.New()
+
+	router, err := swagger.NewRouter(oasFiber.NewRouter(fiberRouter), swagger.Options{
+		Context: context,
+		Openapi: &openapi3.T{
+			Info: &openapi3.Info{
+				Title:   swaggerOpenapiTitle,
+				Version: swaggerOpenapiVersion,
+			},
+		},
+	})
+	require.NoError(t, err)
+
+	operation := swagger.Operation{}
+
+	_, err = router.AddRawRoute(http.MethodGet, "/hello", okHandler, operation)
+	require.NoError(t, err)
+
+	_, err = router.AddRoute(http.MethodPost, "/hello/:value", okHandler, swagger.Definitions{})
+	require.NoError(t, err)
+
+	return fiberRouter, router
+}
+
+func okHandler(c *fiber.Ctx) error {
+	c.Status(http.StatusOK)
+	return c.SendString("OK")
+}
+
+func readBody(t *testing.T, requestBody io.ReadCloser) string {
+	t.Helper()
+
+	body, err := io.ReadAll(requestBody)
+	require.NoError(t, err)
+
+	return string(body)
+}
+
+func readFile(t *testing.T, path string) string {
+	t.Helper()
+
+	fileContent, err := os.ReadFile(path)
+	require.NoError(t, err)
+
+	return string(fileContent)
+}

support/gorilla/examples_test.go

@@ -0,0 +1,118 @@
+package gorilla_test
+
+import (
+	"context"
+	"io"
+	"net/http"
+	"net/http/httptest"
+	"os"
+	"testing"
+
+	swagger "github.com/davidebianchi/gswagger"
+	"github.com/davidebianchi/gswagger/support/gorilla"
+	"github.com/stretchr/testify/require"
+
+	"github.com/getkin/kin-openapi/openapi3"
+	"github.com/gorilla/mux"
+)
+
+func TestExample(t *testing.T) {
+	context := context.Background()
+	muxRouter := mux.NewRouter()
+
+	router, _ := swagger.NewRouter(gorilla.NewRouter(muxRouter), swagger.Options{
+		Context: context,
+		Openapi: &openapi3.T{
+			Info: &openapi3.Info{
+				Title:   "my title",
+				Version: "1.0.0",
+			},
+		},
+	})
+
+	okHandler := func(w http.ResponseWriter, req *http.Request) {
+		w.WriteHeader(http.StatusOK)
+		w.Write([]byte("OK"))
+	}
+
+	type User struct {
+		Name        string   `json:"name" jsonschema:"title=The user name,required" jsonschema_extras:"example=Jane"`
+		PhoneNumber int      `json:"phone" jsonschema:"title=mobile number of user"`
+		Groups      []string `json:"groups,omitempty" jsonschema:"title=groups of the user,default=users"`
+		Address     string   `json:"address" jsonschema:"title=user address"`
+	}
+	type errorResponse struct {
+		Message string `json:"message"`
+	}
+
+	router.AddRoute(http.MethodPost, "/users", okHandler, swagger.Definitions{
+		RequestBody: &swagger.ContentValue{
+			Content: swagger.Content{
+				"application/json": {Value: User{}},
+			},
+		},
+		Responses: map[int]swagger.ContentValue{
+			201: {
+				Content: swagger.Content{
+					"text/html": {Value: ""},
+				},
+			},
+			401: {
+				Content: swagger.Content{
+					"application/json": {Value: &errorResponse{}},
+				},
+				Description: "invalid request",
+			},
+		},
+	})
+
+	router.AddRoute(http.MethodGet, "/users", okHandler, swagger.Definitions{
+		Responses: map[int]swagger.ContentValue{
+			200: {
+				Content: swagger.Content{
+					"application/json": {Value: &[]User{}},
+				},
+			},
+		},
+	})
+
+	carSchema := openapi3.NewObjectSchema().WithProperties(map[string]*openapi3.Schema{
+		"foo": openapi3.NewStringSchema(),
+		"bar": openapi3.NewIntegerSchema().WithMax(15).WithMin(5),
+	})
+	requestBody := openapi3.NewRequestBody().WithJSONSchema(carSchema)
+	operation := swagger.NewOperation()
+	operation.AddRequestBody(requestBody)
+
+	router.AddRawRoute(http.MethodPost, "/cars", okHandler, operation)
+
+	_, err := router.AddRoute(http.MethodGet, "/users/{userId}", okHandler, swagger.Definitions{
+		Querystring: swagger.ParameterValue{
+			"query": {
+				Schema: &swagger.Schema{Value: ""},
+			},
+		},
+	})
+	require.NoError(t, err)
+
+	_, err = router.AddRoute(http.MethodGet, "/cars/{carId}/drivers/{driverId}", okHandler, swagger.Definitions{})
+	require.NoError(t, err)
+
+	router.GenerateAndExposeOpenapi()
+
+	t.Run("correctly exposes documentation", func(t *testing.T) {
+		w := httptest.NewRecorder()
+		req := httptest.NewRequest(http.MethodGet, swagger.DefaultJSONDocumentationPath, nil)
+
+		muxRouter.ServeHTTP(w, req)
+
+		require.Equal(t, http.StatusOK, w.Result().StatusCode)
+		require.Equal(t, "application/json", w.Result().Header.Get("Content-Type"))
+
+		body, err := io.ReadAll(w.Result().Body)
+		require.NoError(t, err)
+		expected, err := os.ReadFile("./testdata/examples-users.json")
+		require.NoError(t, err)
+		require.JSONEq(t, string(expected), string(body), "actual json data: %s", body)
+	})
+}

support/gorilla/gorilla.go

@@ -0,0 +1,39 @@
+package gorilla
+
+import (
+	"github.com/davidebianchi/gswagger/apirouter"
+
+	"net/http"
+
+	"github.com/gorilla/mux"
+)
+
+// HandlerFunc is the http type handler used by gorilla/mux
+type HandlerFunc func(w http.ResponseWriter, req *http.Request)
+type Route = *mux.Route
+
+type gorillaRouter struct {
+	router *mux.Router
+}
+
+func (r gorillaRouter) AddRoute(method string, path string, handler HandlerFunc) Route {
+	return r.router.HandleFunc(path, handler).Methods(method)
+}
+
+func (r gorillaRouter) SwaggerHandler(contentType string, blob []byte) HandlerFunc {
+	return func(w http.ResponseWriter, req *http.Request) {
+		w.Header().Set("Content-Type", contentType)
+		w.WriteHeader(http.StatusOK)
+		w.Write(blob)
+	}
+}
+
+func (r gorillaRouter) TransformPathToOasPath(path string) string {
+	return path
+}
+
+func NewRouter(router *mux.Router) apirouter.Router[HandlerFunc, Route] {
+	return gorillaRouter{
+		router: router,
+	}
+}

support/gorilla/gorilla_test.go

@@ -1,20 +1,22 @@
-package apirouter
+package gorilla
 
 import (
+	"io"
 	"net/http"
 	"net/http/httptest"
 	"testing"
 
+	"github.com/davidebianchi/gswagger/apirouter"
 	"github.com/gorilla/mux"
 	"github.com/stretchr/testify/require"
 )
 
 func TestGorillaMuxRouter(t *testing.T) {
 	muxRouter := mux.NewRouter()
-	ar := NewGorillaMuxRouter(muxRouter)
+	ar := NewRouter(muxRouter)
 
 	t.Run("create a new api router", func(t *testing.T) {
-		require.Implements(t, (*Router)(nil), ar)
+		require.Implements(t, (*apirouter.Router[HandlerFunc, Route])(nil), ar)
 	})
 
 	t.Run("add new route", func(t *testing.T) {
@@ -22,9 +24,7 @@ func TestGorillaMuxRouter(t *testing.T) {
 			w.WriteHeader(200)
 			w.Write(nil)
 		})
-
-		_, ok := route.(*mux.Route)
-		require.True(t, ok)
+		require.IsType(t, route, &mux.Route{})
 
 		t.Run("router exposes correctly api", func(t *testing.T) {
 			w := httptest.NewRecorder()
@@ -44,4 +44,23 @@ func TestGorillaMuxRouter(t *testing.T) {
 			require.Equal(t, http.StatusMethodNotAllowed, w.Result().StatusCode)
 		})
 	})
+
+	t.Run("create openapi handler", func(t *testing.T) {
+		handlerFunc := ar.SwaggerHandler("text/html", []byte("some data"))
+		muxRouter.HandleFunc("/oas", handlerFunc).Methods(http.MethodGet)
+
+		t.Run("responds correctly to the API", func(t *testing.T) {
+			w := httptest.NewRecorder()
+			r := httptest.NewRequest(http.MethodGet, "/oas", nil)
+
+			muxRouter.ServeHTTP(w, r)
+
+			require.Equal(t, http.StatusOK, w.Result().StatusCode)
+			require.Equal(t, "text/html", w.Result().Header.Get("Content-Type"))
+
+			body, err := io.ReadAll(w.Result().Body)
+			require.NoError(t, err)
+			require.Equal(t, "some data", string(body))
+		})
+	})
 }

support/gorilla/integration_test.go

@@ -0,0 +1,157 @@
+package gorilla_test
+
+import (
+	"context"
+	"io"
+	"net/http"
+	"net/http/httptest"
+	"os"
+	"testing"
+
+	swagger "github.com/davidebianchi/gswagger"
+	"github.com/davidebianchi/gswagger/support/gorilla"
+	"github.com/getkin/kin-openapi/openapi3"
+	"github.com/gorilla/mux"
+	"github.com/stretchr/testify/require"
+)
+
+const (
+	swaggerOpenapiTitle   = "test openapi title"
+	swaggerOpenapiVersion = "test openapi version"
+)
+
+type SwaggerRouter = swagger.Router[gorilla.HandlerFunc, gorilla.Route]
+
+func TestGorillaIntegration(t *testing.T) {
+	t.Run("router works correctly", func(t *testing.T) {
+		muxRouter, oasRouter := setupSwagger(t)
+
+		err := oasRouter.GenerateAndExposeOpenapi()
+		require.NoError(t, err)
+
+		w := httptest.NewRecorder()
+		r := httptest.NewRequest(http.MethodGet, "/hello", nil)
+
+		muxRouter.ServeHTTP(w, r)
+
+		require.Equal(t, http.StatusOK, w.Result().StatusCode)
+
+		body := readBody(t, w.Result().Body)
+		require.Equal(t, "OK", body)
+
+		t.Run("and generate swagger", func(t *testing.T) {
+			w := httptest.NewRecorder()
+			r := httptest.NewRequest(http.MethodGet, swagger.DefaultJSONDocumentationPath, nil)
+
+			muxRouter.ServeHTTP(w, r)
+
+			require.Equal(t, http.StatusOK, w.Result().StatusCode)
+
+			body := readBody(t, w.Result().Body)
+			require.JSONEq(t, readFile(t, "../testdata/integration.json"), body)
+		})
+	})
+
+	t.Run("works correctly with subrouter - handles path prefix - gorilla mux", func(t *testing.T) {
+		muxRouter, oasRouter := setupSwagger(t)
+
+		muxSubRouter := muxRouter.NewRoute().Subrouter()
+		subRouter, err := oasRouter.SubRouter(gorilla.NewRouter(muxSubRouter), swagger.SubRouterOptions{
+			PathPrefix: "/prefix",
+		})
+		require.NoError(t, err)
+
+		_, err = subRouter.AddRoute(http.MethodGet, "/foo", okHandler, swagger.Definitions{})
+		require.NoError(t, err)
+
+		err = oasRouter.GenerateAndExposeOpenapi()
+		require.NoError(t, err)
+
+		t.Run("correctly call router", func(t *testing.T) {
+			w := httptest.NewRecorder()
+			r := httptest.NewRequest(http.MethodGet, "/hello", nil)
+
+			muxRouter.ServeHTTP(w, r)
+
+			require.Equal(t, http.StatusOK, w.Result().StatusCode)
+
+			body := readBody(t, w.Result().Body)
+			require.Equal(t, "OK", body)
+		})
+
+		t.Run("correctly call sub router", func(t *testing.T) {
+			w := httptest.NewRecorder()
+			r := httptest.NewRequest(http.MethodGet, "/prefix/foo", nil)
+
+			muxRouter.ServeHTTP(w, r)
+
+			require.Equal(t, http.StatusOK, w.Result().StatusCode)
+
+			body := readBody(t, w.Result().Body)
+			require.Equal(t, "OK", body)
+		})
+
+		t.Run("and generate swagger", func(t *testing.T) {
+			w := httptest.NewRecorder()
+			r := httptest.NewRequest(http.MethodGet, swagger.DefaultJSONDocumentationPath, nil)
+
+			muxRouter.ServeHTTP(w, r)
+
+			require.Equal(t, http.StatusOK, w.Result().StatusCode)
+
+			body := readBody(t, w.Result().Body)
+			require.JSONEq(t, readFile(t, "../testdata/intergation-subrouter.json"), body, body)
+		})
+	})
+}
+
+func readBody(t *testing.T, requestBody io.ReadCloser) string {
+	t.Helper()
+
+	body, err := io.ReadAll(requestBody)
+	require.NoError(t, err)
+
+	return string(body)
+}
+
+func setupSwagger(t *testing.T) (*mux.Router, *SwaggerRouter) {
+	t.Helper()
+
+	context := context.Background()
+	muxRouter := mux.NewRouter()
+
+	router, err := swagger.NewRouter(gorilla.NewRouter(muxRouter), swagger.Options{
+		Context: context,
+		Openapi: &openapi3.T{
+			Info: &openapi3.Info{
+				Title:   swaggerOpenapiTitle,
+				Version: swaggerOpenapiVersion,
+			},
+		},
+	})
+	require.NoError(t, err)
+
+	operation := swagger.Operation{}
+
+	_, err = router.AddRawRoute(http.MethodGet, "/hello", okHandler, operation)
+	require.NoError(t, err)
+
+	_, err = router.AddRoute(http.MethodPost, "/hello/{value}", okHandler, swagger.Definitions{})
+	require.NoError(t, err)
+
+	return muxRouter, router
+}
+
+func okHandler(w http.ResponseWriter, req *http.Request) {
+	w.WriteHeader(http.StatusOK)
+	w.Write([]byte(`OK`))
+}
+
+func readFile(t *testing.T, path string) string {
+	t.Helper()
+
+	fileContent, err := os.ReadFile(path)
+	require.NoError(t, err)
+
+	return string(fileContent)
+}

support/gorilla/testdata/examples-users.json

@@ -0,0 +1,185 @@
+{
+  "info": {
+    "title": "my title",
+    "version": "1.0.0"
+  },
+  "openapi": "3.0.0",
+  "paths": {
+    "/cars/{carId}/drivers/{driverId}": {
+      "get": {
+        "parameters": [
+          {
+            "in": "path",
+            "name": "carId",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "in": "path",
+            "name": "driverId",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "default": {
+            "description": ""
+          }
+        }
+      }
+    },
+    "/users": {
+      "get": {
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "items": {
+                    "additionalProperties": false,
+                    "properties": {
+                      "address": {
+                        "title": "user address",
+                        "type": "string"
+                      },
+                      "groups": {
+                        "default": [
+                          "users"
+                        ],
+                        "items": {
+                          "type": "string"
+                        },
+                        "title": "groups of the user",
+                        "type": "array"
+                      },
+                      "name": {
+                        "example": "Jane",
+                        "title": "The user name",
+                        "type": "string"
+                      },
+                      "phone": {
+                        "title": "mobile number of user",
+                        "type": "integer"
+                      }
+                    },
+                    "required": [
+                      "name",
+                      "phone",
+                      "address"
+                    ],
+                    "type": "object"
+                  },
+                  "type": "array"
+                }
+              }
+            },
+            "description": ""
+          }
+        }
+      },
+      "post": {
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "additionalProperties": false,
+                "properties": {
+                  "address": {
+                    "title": "user address",
+                    "type": "string"
+                  },
+                  "groups": {
+                    "default": [
+                      "users"
+                    ],
+                    "items": {
+                      "type": "string"
+                    },
+                    "title": "groups of the user",
+                    "type": "array"
+                  },
+                  "name": {
+                    "example": "Jane",
+                    "title": "The user name",
+                    "type": "string"
+                  },
+                  "phone": {
+                    "title": "mobile number of user",
+                    "type": "integer"
+                  }
+                },
+                "required": [
+                  "name",
+                  "phone",
+                  "address"
+                ],
+                "type": "object"
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "content": {
+              "text/html": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            },
+            "description": ""
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "additionalProperties": false,
+                  "properties": {
+                    "message": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "message"
+                  ],
+                  "type": "object"
+                }
+              }
+            },
+            "description": "invalid request"
+          }
+        }
+      }
+    },
+    "/users/{userId}": {
+      "get": {
+        "parameters": [
+          {
+            "in": "path",
+            "name": "userId",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "in": "query",
+            "name": "query",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "default": {
+            "description": ""
+          }
+        }
+      }
+    }
+  }
+}

support/testdata/integration.json

@@ -0,0 +1,37 @@
+{
+  "info": {
+    "title": "test openapi title",
+    "version": "test openapi version"
+  },
+  "openapi": "3.0.0",
+  "paths": {
+    "/hello": {
+      "get": {
+        "responses": {
+          "default": {
+            "description": ""
+          }
+        }
+      }
+    },
+    "/hello/{value}": {
+      "post": {
+        "parameters": [
+          {
+            "in": "path",
+            "name": "value",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "default": {
+            "description": ""
+          }
+        }
+      }
+    }
+  }
+}

support/testdata/intergation-subrouter.json

@@ -0,0 +1,46 @@
+{
+  "info": {
+    "title": "test openapi title",
+    "version": "test openapi version"
+  },
+  "openapi": "3.0.0",
+  "paths": {
+    "/hello": {
+      "get": {
+        "responses": {
+          "default": {
+            "description": ""
+          }
+        }
+      }
+    },
+    "/hello/{value}": {
+      "post": {
+        "parameters": [
+          {
+            "in": "path",
+            "name": "value",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "default": {
+            "description": ""
+          }
+        }
+      }
+    },
+    "/prefix/foo": {
+      "get": {
+        "responses": {
+          "default": {
+            "description": ""
+          }
+        }
+      }
+    }
+  }
+}

testdata/allof.json

@@ -1,8 +1,7 @@
 {
-  "components": {},
   "info": {
-    "title": "test swagger title",
-    "version": "test swagger version"
+    "title": "test openapi title",
+    "version": "test openapi version"
   },
   "openapi": "3.0.0",
   "paths": {

testdata/anyof.json

@@ -1,8 +1,7 @@
 {
-  "components": {},
   "info": {
-    "title": "test swagger title",
-    "version": "test swagger version"
+    "title": "test openapi title",
+    "version": "test openapi version"
   },
   "openapi": "3.0.0",
   "paths": {

testdata/cookies.json

@@ -1,8 +1,7 @@
 {
-  "components": {},
   "info": {
-    "title": "test swagger title",
-    "version": "test swagger version"
+    "title": "test openapi title",
+    "version": "test openapi version"
   },
   "openapi": "3.0.0",
   "paths": {

testdata/empty-route-schema.json

@@ -1,8 +1,7 @@
 {
-  "components": {},
   "info": {
-    "title": "test swagger title",
-    "version": "test swagger version"
+    "title": "test openapi title",
+    "version": "test openapi version"
   },
   "openapi": "3.0.0",
   "paths": {

testdata/empty.json

@@ -1,8 +1,7 @@
 {
-  "components": {},
   "info": {
-    "title": "test swagger title",
-    "version": "test swagger version"
+    "title": "test openapi title",
+    "version": "test openapi version"
   },
   "openapi": "3.0.0",
   "paths": {}

testdata/extension.json

@@ -0,0 +1,21 @@
+{
+  "info": {
+    "title": "test openapi title",
+    "version": "test openapi version"
+  },
+  "openapi": "3.0.0",
+  "paths": {
+    "/users": {
+      "get": {
+        "responses": {
+          "default": {
+            "description": ""
+          }
+        },
+        "x-extension-field": {
+          "foo": "bar"
+        }
+      }
+    }
+  }
+}

testdata/headers.json

@@ -1,8 +1,7 @@
 {
-  "components": {},
   "info": {
-    "title": "test swagger title",
-    "version": "test swagger version"
+    "title": "test openapi title",
+    "version": "test openapi version"
   },
   "openapi": "3.0.0",
   "paths": {

testdata/multipart-requestbody.json

@@ -1,8 +1,7 @@
 {
-  "components": {},
   "info": {
-    "title": "test swagger title",
-    "version": "test swagger version"
+    "title": "test openapi title",
+    "version": "test openapi version"
   },
   "openapi": "3.0.0",
   "paths": {

testdata/oneOf.json

@@ -1,8 +1,7 @@
 {
-  "components": {},
   "info": {
-    "title": "test swagger title",
-    "version": "test swagger version"
+    "title": "test openapi title",
+    "version": "test openapi version"
   },
   "openapi": "3.0.0",
   "paths": {
@@ -79,6 +78,11 @@
                       }
                     ],
                     "title": "custom properties"
+                  },
+                  "userType": {
+                    "title": "type of user",
+                    "type": "string",
+                    "enum": ["simple", "advanced"]
                   }
                 },
                 "required": [

testdata/params-autofill.json

@@ -1,8 +1,7 @@
 {
-  "components": {},
   "info": {
-    "title": "test swagger title",
-    "version": "test swagger version"
+    "title": "test openapi title",
+    "version": "test openapi version"
   },
   "openapi": "3.0.0",
   "paths": {
@@ -58,6 +57,33 @@
           }
         }
       }
+    },
+    "/files/{name}.{extension}": {
+      "get": {
+        "parameters": [
+          {
+            "in": "path",
+            "name": "extension",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "in": "path",
+            "name": "name",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "default": {
+            "description": ""
+          }
+        }
+      }
     }
   }
 }

testdata/params.json

@@ -1,8 +1,7 @@
 {
-  "components": {},
   "info": {
-    "title": "test swagger title",
-    "version": "test swagger version"
+    "title": "test openapi title",
+    "version": "test openapi version"
   },
   "openapi": "3.0.0",
   "paths": {

testdata/query.json

@@ -1,8 +1,7 @@
 {
-  "components": {},
   "info": {
-    "title": "test swagger title",
-    "version": "test swagger version"
+    "title": "test openapi title",
+    "version": "test openapi version"
   },
   "openapi": "3.0.0",
   "paths": {

testdata/router_with_prefix.json

@@ -1,8 +1,7 @@
 {
-  "components": {},
   "info": {
-    "title": "test swagger title",
-    "version": "test swagger version"
+    "title": "test openapi title",
+    "version": "test openapi version"
   },
   "openapi": "3.0.0",
   "paths": {

testdata/schema-no-content.json

@@ -1,8 +1,7 @@
 {
-  "components": {},
   "info": {
-    "title": "test swagger title",
-    "version": "test swagger version"
+    "title": "test openapi title",
+    "version": "test openapi version"
   },
   "openapi": "3.0.0",
   "paths": {

testdata/security.json

@@ -0,0 +1,26 @@
+{
+  "info": {
+    "title": "test openapi title",
+    "version": "test openapi version"
+  },
+  "openapi": "3.0.0",
+  "paths": {
+    "/users": {
+      "get": {
+        "responses": {
+          "default": {
+            "description": ""
+          }
+        },
+        "security": [
+          {
+            "api_key": [],
+            "auth": [
+              "resource.write"
+            ]
+          }
+        ]
+      }
+    }
+  }
+}

testdata/subrouter.json

@@ -1,8 +1,7 @@
 {
-  "components": {},
   "info": {
-    "title": "test swagger title",
-    "version": "test swagger version"
+    "title": "test openapi title",
+    "version": "test openapi version"
   },
   "openapi": "3.0.0",
   "paths": {

testdata/tags.json

@@ -1,8 +1,7 @@
 {
-  "components": {},
   "info": {
-    "title": "test swagger title",
-    "version": "test swagger version"
+    "title": "test openapi title",
+    "version": "test openapi version"
   },
   "openapi": "3.0.0",
   "paths": {

testdata/users-deprecated-with-description.json

@@ -0,0 +1,21 @@
+{
+  "info": {
+    "title": "test openapi title",
+    "version": "test openapi version"
+  },
+  "openapi": "3.0.0",
+  "paths": {
+    "/users": {
+      "get": {
+        "deprecated": true,
+        "description": "this is the long route description",
+        "responses": {
+          "default": {
+            "description": ""
+          }
+        },
+        "summary": "small description"
+      }
+    }
+  }
+}

testdata/users_employees.json

@@ -1,8 +1,7 @@
 {
-  "components": {},
   "info": {
-    "title": "test swagger title",
-    "version": "test swagger version"
+    "title": "test openapi title",
+    "version": "test openapi version"
   },
   "openapi": "3.0.0",
   "paths": {

testdata/users_employees.yaml

@@ -1,7 +1,6 @@
-components: {}
 info:
-  title: test swagger title
-  version: test swagger version
+  title: test openapi title
+  version: test openapi version
 openapi: 3.0.0
 paths:
   /employees: