* Added BuildStream and AddRoute functions

* Moved existing example to examples/file_output
* Added new exampe examples/stream_output
* Updated readme.md

Author: padiazg

.gitignore

@@ -3,4 +3,5 @@
 #internal/dist/openapi.yaml
 testing_out.yaml
 ./testing_out.yaml
-internal/dist/openapi.yaml
+internal/dist/openapi.yaml
+.vscode

README.md

@@ -119,7 +119,9 @@ other parts of the system for that matter.
 To run examples, and checkout hosted documentation via Swagger UI, issue the following command:
 
 ```sh
-$ go run ./examples/*.go
+$ go run ./examples/file_output/*.go
+# or uncomment line 40 and comment line 38 in internal/dist/index.html before running:
+$ go run ./examples/stream_output/*.go
 ```
 
 And navigate to `http://localhost:3005/docs/api/` in case that you didn't change anything before running the example

build.go

@@ -38,7 +38,7 @@ func getPathFromFirstElement(cbs []ConfigBuilder) string {
 func (o *OAS) BuildDocs(conf ...ConfigBuilder) error {
 	o.initCallStackForRoutes()
 
-	yml, err := marshalToYAML(o)
+	yml, err := o.marshalToYAML()
 	if err != nil {
 		return fmt.Errorf("marshaling issue occurred: %w", err)
 	}
@@ -51,7 +51,23 @@ 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 (o *OAS) BuildStream(w io.Writer) error {
+	yml, err := o.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)

examples/api-documentation.go examples/file_output/api-documentation.goexamples/api-documentation.go renamed to examples/file_output/api-documentation.go

@@ -0,0 +1,47 @@
+package main
+
+import (
+	"log"
+	"net/http"
+	"time"
+)
+
+type responseData struct {
+	status int
+	size   int
+}
+
+// our http.ResponseWriter implementation
+type loggingResponseWriter struct {
+	http.ResponseWriter // compose original http.ResponseWriter
+	responseData        *responseData
+}
+
+func (r *loggingResponseWriter) Write(b []byte) (int, error) {
+	size, err := r.ResponseWriter.Write(b) // write response using original http.ResponseWriter
+	r.responseData.size += size            // capture size
+	return size, err
+}
+
+func (r *loggingResponseWriter) WriteHeader(statusCode int) {
+	r.ResponseWriter.WriteHeader(statusCode) // write status code using original http.ResponseWriter
+	r.responseData.status = statusCode       // capture status code
+}
+
+func LogginMiddleware(h http.Handler) http.Handler {
+	return http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
+		var (
+			start        = time.Now()
+			responseData = &responseData{}
+		)
+
+		h.ServeHTTP(&loggingResponseWriter{
+			ResponseWriter: rw,
+			responseData:   responseData,
+		}, req)
+
+		duration := time.Since(start)
+
+		log.Printf("%s[%v] uri:%s duration:%v size:%d", req.Method, responseData.status, req.RequestURI, duration, responseData.size)
+	})
+}