Merge branch 'main' into parameters-support

Author: padiazg

.golangci.yml

@@ -47,7 +47,6 @@ linters:
     - nakedret
     - nestif
     - prealloc
-    - rowserrcheck
     - staticcheck
     - stylecheck
     - typecheck
@@ -64,7 +63,6 @@ linters:
     - gofumpt
     - goheader
     - noctx
-    - sqlclosecheck
     - errorlint
     - paralleltest
     - tparallel
@@ -83,4 +81,9 @@ issues:
         - gochecknoglobals
     - path: _test\.go
       linters:
-        - exhaustivestruct
+        - exhaustivestruct
+        - funlen
+        - wrapcheck
+    - path: server.go
+      linters:
+        - wrapcheck

Makefile

@@ -1,5 +1,5 @@
 lint:
-	gofumpt -w -s ./..
+	gofumpt -w ./..
 	golangci-lint run --fix
 
 test:

examples/stream_output/main.go

@@ -24,7 +24,7 @@ func main() {
 	apiSetExternalDocs(&apiDoc)
 	apiSetComponents(&apiDoc)
 
-	apiDoc.AddRoute(docs.Path{
+	apiDoc.AddRoute(&docs.Path{
 		Route:       "/users",
 		HTTPMethod:  "POST",
 		OperationID: "createUser",
@@ -43,7 +43,7 @@ func main() {
 		},
 	})
 
-	apiDoc.AddRoute(docs.Path{
+	apiDoc.AddRoute(&docs.Path{
 		Route:       "/users",
 		HTTPMethod:  "GET",
 		OperationID: "getUser",

go.mod

@@ -1,6 +1,6 @@
 module github.com/go-oas/docs
 
-go 1.18
+go 1.19
 
 require gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b
 

routing.go

@@ -40,6 +40,6 @@ func (oas *OAS) GetPathByIndex(index int) *Path {
 }
 
 // AddRoute is used for add API documentation routes.
-func (oas *OAS) AddRoute(path Path) {
-	oas.Paths = append(oas.Paths, path)
+func (oas *OAS) AddRoute(path *Path) {
+	oas.Paths = append(oas.Paths, *path)
 }

routing_test.go

@@ -270,6 +270,8 @@ func TestQuickUnitAttachRoutes(t *testing.T) {
 }
 
 func TestOAS_AddRoute(t *testing.T) {
+	t.Parallel()
+
 	var (
 		respose200         = Response{Code: 200, Description: "Ok"}
 		respose404         = Response{Code: 404, Description: "Not Found"}
@@ -305,27 +307,32 @@ func TestOAS_AddRoute(t *testing.T) {
 	tests := []struct {
 		name      string
 		oas       *OAS
-		path      Path
+		path      *Path
 		wantPaths Paths
 	}{
 		{
 			name:      "success-no-existing-paths",
 			oas:       &OAS{},
-			path:      pathGetUser,
+			path:      &pathGetUser,
 			wantPaths: Paths{pathGetUser},
 		},
 		{
 			name:      "success-existing-paths",
 			oas:       &OAS{Paths: Paths{pathGetUser}},
-			path:      pathCreateUser,
+			path:      &pathCreateUser,
 			wantPaths: Paths{pathGetUser, pathCreateUser},
 		},
 	}
+
 	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			tt.oas.AddRoute(tt.path)
-			if !reflect.DeepEqual(tt.wantPaths, tt.oas.Paths) {
-				t.Errorf("OAS.AddRoute() = [%v], want {%v}", tt.oas.Paths, tt.wantPaths)
+		trn := tt
+
+		t.Run(trn.name, func(t *testing.T) {
+			t.Parallel()
+
+			trn.oas.AddRoute(trn.path)
+			if !reflect.DeepEqual(trn.wantPaths, trn.oas.Paths) {
+				t.Errorf("OAS.AddRoute() = [%v], want {%v}", trn.oas.Paths, trn.wantPaths)
 			}
 		})
 	}

server.go

@@ -18,6 +18,7 @@ const (
 	defaultIndexPath           = "/index.html"
 	fwSlashSuffix              = "/"
 	sigContSleeperMilliseconds = 20
+	readHeaderTimeout          = 60 * time.Second // same than nginx
 )
 
 // ConfigSwaggerUI represents a structure which will be used to pass required configuration params to
@@ -156,8 +157,9 @@ func (c *ConfigSwaggerUI) initializeDefaultHTTPServer() {
 	fileServer := http.FileServer(c.initFS)
 
 	c.httpServer = &http.Server{
-		Addr:    fmt.Sprintf(":%s", c.Port),
-		Handler: http.StripPrefix(strings.TrimRight(c.Route, fwSlashSuffix), fileServer),
+		Addr:              fmt.Sprintf(":%s", c.Port),
+		Handler:           http.StripPrefix(strings.TrimRight(c.Route, fwSlashSuffix), fileServer),
+		ReadHeaderTimeout: readHeaderTimeout,
 	}
 }