WIP

Author: padiazg

build.go

@@ -35,10 +35,10 @@ func getPathFromFirstElement(cbs []ConfigBuilder) string {
 // BuildDocs marshals the OAS struct to YAML and saves it to the chosen output file.
 //
 // Returns an error if there is any.
-func (o *OAS) BuildDocs(conf ...ConfigBuilder) error {
-	o.initCallStackForRoutes()
+func (oas *OAS) BuildDocs(conf ...ConfigBuilder) error {
+	oas.initCallStackForRoutes()
 
-	yml, err := marshalToYAML(o)
+	yml, err := oas.marshalToYAML()
 	if err != nil {
 		return fmt.Errorf("marshaling issue occurred: %w", err)
 	}
@@ -51,7 +51,24 @@ func (o *OAS) BuildDocs(conf ...ConfigBuilder) error {
 	return nil
 }
 
-func marshalToYAML(oas *OAS) ([]byte, error) {
+// BuildStream marshals the OAS struct to YAML and writes it to a stream.
+//
+// Returns an error if there is any.
+func (oas *OAS) BuildStream(w io.Writer) error {
+	yml, err := oas.marshalToYAML()
+	if err != nil {
+		return fmt.Errorf("marshaling issue occurred: %w", err)
+	}
+
+	err = writeAndFlush(yml, w)
+	if err != nil {
+		return fmt.Errorf("writing issue occurred: %w", err)
+	}
+
+	return nil
+}
+
+func (oas *OAS) marshalToYAML() ([]byte, error) {
 	transformedOAS := oas.transformToHybridOAS()
 
 	yml, err := yaml.Marshal(transformedOAS)
@@ -111,17 +128,17 @@ type hybridOAS struct {
 	Components   componentsMap `yaml:"components"`
 }
 
-func (o *OAS) transformToHybridOAS() hybridOAS {
+func (oas *OAS) transformToHybridOAS() hybridOAS {
 	ho := hybridOAS{}
 
-	ho.OpenAPI = o.OASVersion
-	ho.Info = o.Info
-	ho.ExternalDocs = o.ExternalDocs
-	ho.Servers = o.Servers
-	ho.Tags = o.Tags
+	ho.OpenAPI = oas.OASVersion
+	ho.Info = oas.Info
+	ho.ExternalDocs = oas.ExternalDocs
+	ho.Servers = oas.Servers
+	ho.Tags = oas.Tags
 
-	ho.Paths = makeAllPathsMap(&o.Paths)
-	ho.Components = makeComponentsMap(&o.Components)
+	ho.Paths = makeAllPathsMap(&oas.Paths)
+	ho.Components = makeComponentsMap(&oas.Components)
 
 	return ho
 }

build_test.go

@@ -1,6 +1,58 @@
 package docs
 
-import "testing"
+import (
+	"bytes"
+	"testing"
+)
+
+const (
+	buildStreamTestWant = `openapi: 3.0.1
+info:
+    title: Test
+    description: Test object
+    termsOfService: ""
+    contact:
+        email: ""
+    license:
+        name: ""
+        url: ""
+    version: ""
+externalDocs:
+    description: ""
+    url: ""
+servers: []
+tags: []
+paths: {}
+components:
+    schemas:
+        schema_testing:
+            properties:
+                EnumProp:
+                    description: short desc
+                    enum:
+                        - enum
+                        - test
+                        - strSlc
+                    type: enum
+                intProp:
+                    default: 1337
+                    description: short desc
+                    format: int64
+                    type: integer
+            type: ""
+            xml:
+                name: XML entry test
+    securitySchemes:
+        ses_scheme_testing:
+            flows:
+                implicit:
+                    authorizationUrl: http://petstore.swagger.io/oauth/dialog
+                    scopes:
+                        read:pets: Read Pets
+                        write:pets: Write to Pets
+            in: not empty
+`
+)
 
 func TestUnitBuild(t *testing.T) {
 	t.Parallel()
@@ -109,3 +161,68 @@ func TestUnitGetPathFromFirstElem(t *testing.T) {
 }
 
 // QUICK CHECK TESTS ARE COMING WITH NEXT RELEASE.
+
+func TestOAS_BuildStream(t *testing.T) {
+	t.Parallel()
+
+	tests := []struct {
+		name    string
+		oas     *OAS
+		wantW   string
+		wantErr bool
+	}{
+		{
+			name: "success",
+			oas: &OAS{
+				OASVersion: "3.0.1",
+				Info:       Info{Title: "Test", Description: "Test object"},
+				Components: Components{
+					Component{
+						Schemas: Schemas{Schema{
+							Name: "schema_testing",
+							Properties: SchemaProperties{
+								SchemaProperty{
+									Name: "EnumProp", Type: "enum", Description: "short desc",
+									Enum: []string{"enum", "test", "strSlc"},
+								},
+								SchemaProperty{
+									Name: "intProp", Type: "integer", Format: "int64",
+									Description: "short desc", Default: 1337,
+								},
+							},
+							XML: XMLEntry{Name: "XML entry test"},
+						}},
+						SecuritySchemes: SecuritySchemes{SecurityScheme{
+							Name: "ses_scheme_testing",
+							In:   "not empty",
+							Flows: SecurityFlows{SecurityFlow{
+								Type:    "implicit",
+								AuthURL: "http://petstore.swagger.io/oauth/dialog",
+								Scopes: SecurityScopes{
+									SecurityScope{Name: "write:pets", Description: "Write to Pets"},
+									SecurityScope{Name: "read:pets", Description: "Read Pets"},
+								},
+							}},
+						}},
+					},
+				},
+			},
+			wantErr: false,
+			wantW:   buildStreamTestWant,
+		},
+	}
+
+	t.Parallel()
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			w := &bytes.Buffer{}
+			if err := tt.oas.BuildStream(w); (err != nil) != tt.wantErr {
+				t.Errorf("OAS.BuildStream() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+			if gotW := w.String(); gotW != tt.wantW {
+				t.Errorf("OAS.BuildStream() = [%v], want {%v}", gotW, tt.wantW)
+			}
+		})
+	}
+}

server.go

@@ -18,10 +18,12 @@ 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
-//		the ServeSwaggerUI func.
+//
+//	the ServeSwaggerUI func.
 type ConfigSwaggerUI struct {
 	Route string
 	Port  string
@@ -155,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,
 	}
 }