feat: add option to pretty print json doc output

Author: dylanhitt

openapi.go

@@ -59,7 +59,7 @@ func (s *Server) OutputOpenAPISpec() openapi3.T {
 	}
 
 	// Marshal spec to JSON
-	jsonSpec, err := json.Marshal(s.OpenApiSpec)
+	jsonSpec, err := s.marshalSpec()
 	if err != nil {
 		slog.Error("Error marshalling spec to JSON", "error", err)
 	}
@@ -78,6 +78,13 @@ func (s *Server) OutputOpenAPISpec() openapi3.T {
 	return s.OpenApiSpec
 }
 
+func (s *Server) marshalSpec() ([]byte, error) {
+	if s.OpenAPIConfig.PrettyFormatJson {
+		return json.MarshalIndent(s.OpenApiSpec, "", "	")
+	}
+	return json.Marshal(s.OpenApiSpec)
+}
+
 func saveOpenAPIToFile(jsonSpecLocalPath string, jsonSpec []byte) error {
 	jsonFolder := filepath.Dir(jsonSpecLocalPath)
 

openapi_test.go

@@ -1,7 +1,9 @@
 package fuego
 
 import (
+	"bytes"
 	"fmt"
+	"io"
 	"net/http/httptest"
 	"os"
 	"testing"
@@ -79,6 +81,106 @@ func TestServer_generateOpenAPI(t *testing.T) {
 	})
 }
 
+func TestServer_OutputOpenApiSpec(t *testing.T) {
+	docPath := "doc/openapi.json"
+	t.Run("base", func(t *testing.T) {
+		s := NewServer(
+			WithOpenAPIConfig(
+				OpenAPIConfig{
+					JsonFilePath: docPath,
+				},
+			),
+		)
+		Get(s, "/", func(*ContextNoBody) (MyStruct, error) {
+			return MyStruct{}, nil
+		})
+
+		document := s.OutputOpenAPISpec()
+		require.NotNil(t, document)
+
+		file, err := os.Open(docPath)
+		require.NoError(t, err)
+		require.NotNil(t, file)
+		defer os.Remove(file.Name())
+		require.Equal(t, 1, lineCounter(t, file))
+	})
+	t.Run("do not print file", func(t *testing.T) {
+		s := NewServer(
+			WithOpenAPIConfig(
+				OpenAPIConfig{
+					JsonFilePath:     docPath,
+					DisableLocalSave: true,
+				},
+			),
+		)
+		Get(s, "/", func(*ContextNoBody) (MyStruct, error) {
+			return MyStruct{}, nil
+		})
+
+		document := s.OutputOpenAPISpec()
+		require.NotNil(t, document)
+
+		file, err := os.Open(docPath)
+		require.Error(t, err)
+		require.Nil(t, file)
+	})
+	t.Run("swagger disabled", func(t *testing.T) {
+		s := NewServer(
+			WithOpenAPIConfig(
+				OpenAPIConfig{
+					JsonFilePath:     docPath,
+					DisableLocalSave: true,
+					DisableSwagger:   true,
+				},
+			),
+		)
+		Get(s, "/", func(*ContextNoBody) (MyStruct, error) {
+			return MyStruct{}, nil
+		})
+
+		document := s.OutputOpenAPISpec()
+		require.Len(t, document.Paths.Map(), 1)
+		require.NotNil(t, document)
+
+		file, err := os.Open(docPath)
+		require.Error(t, err)
+		require.Nil(t, file)
+	})
+	t.Run("pretty format json file", func(t *testing.T) {
+		s := NewServer(
+			WithOpenAPIConfig(
+				OpenAPIConfig{
+					JsonFilePath:     docPath,
+					PrettyFormatJson: true,
+				},
+			),
+		)
+		Get(s, "/", func(*ContextNoBody) (MyStruct, error) {
+			return MyStruct{}, nil
+		})
+
+		document := s.OutputOpenAPISpec()
+		require.NotNil(t, document)
+
+		file, err := os.Open(docPath)
+		require.NoError(t, err)
+		require.NotNil(t, file)
+		defer os.Remove(file.Name())
+		require.Greater(t, lineCounter(t, file), 1)
+	})
+}
+
+func lineCounter(t *testing.T, r io.Reader) int {
+	buf := make([]byte, 32*1024)
+	count := 1
+	lineSep := []byte{'\n'}
+
+	c, err := r.Read(buf)
+	require.NoError(t, err)
+	count += bytes.Count(buf[:c], lineSep)
+	return count
+}
+
 func BenchmarkRoutesRegistration(b *testing.B) {
 	for range b.N {
 		s := NewServer(

options.go

@@ -23,6 +23,7 @@ type OpenAPIConfig struct {
 	UIHandler        func(specURL string) http.Handler // Handler to serve the openapi ui from spec url
 	JsonUrl          string                            // URL to serve the openapi json spec
 	JsonFilePath     string                            // Local path to save the openapi json spec
+	PrettyFormatJson bool                              // Pretty prints the open api spec with proper json indentation
 }
 
 var defaultOpenAPIConfig = OpenAPIConfig{
@@ -288,13 +289,9 @@ func WithOpenAPIConfig(openapiConfig OpenAPIConfig) func(*Server) {
 			s.OpenAPIConfig.UIHandler = openapiConfig.UIHandler
 		}
 
-		if openapiConfig.DisableSwagger {
-			s.OpenAPIConfig.DisableSwagger = true
-		}
-
-		if openapiConfig.DisableLocalSave {
-			s.OpenAPIConfig.DisableLocalSave = true
-		}
+		s.OpenAPIConfig.DisableSwagger = openapiConfig.DisableSwagger
+		s.OpenAPIConfig.DisableLocalSave = openapiConfig.DisableLocalSave
+		s.OpenAPIConfig.PrettyFormatJson = openapiConfig.PrettyFormatJson
 
 		if !validateJsonSpecLocalPath(s.OpenAPIConfig.JsonFilePath) {
 			slog.Error("Error writing json spec. Value of 'jsonSpecLocalPath' option is not valid", "file", s.OpenAPIConfig.JsonFilePath)

options_test.go

@@ -75,6 +75,7 @@ func TestWithOpenAPIConfig(t *testing.T) {
 		require.Equal(t, "/swagger", s.OpenAPIConfig.SwaggerUrl)
 		require.Equal(t, "/swagger/openapi.json", s.OpenAPIConfig.JsonUrl)
 		require.Equal(t, "doc/openapi.json", s.OpenAPIConfig.JsonFilePath)
+		require.False(t, s.OpenAPIConfig.PrettyFormatJson)
 	})
 
 	t.Run("with custom values", func(t *testing.T) {
@@ -85,6 +86,7 @@ func TestWithOpenAPIConfig(t *testing.T) {
 				JsonFilePath:     "openapi.json",
 				DisableSwagger:   true,
 				DisableLocalSave: true,
+				PrettyFormatJson: true,
 			}),
 		)
 
@@ -93,6 +95,7 @@ func TestWithOpenAPIConfig(t *testing.T) {
 		require.Equal(t, "openapi.json", s.OpenAPIConfig.JsonFilePath)
 		require.True(t, s.OpenAPIConfig.DisableSwagger)
 		require.True(t, s.OpenAPIConfig.DisableLocalSave)
+		require.True(t, s.OpenAPIConfig.PrettyFormatJson)
 	})
 
 	t.Run("with invalid local path values", func(t *testing.T) {