Make the OpenAPI UI Handler public in OpenAPIConfig struct

examples/full-app-gourmet/views/views.go

@@ -45,5 +45,4 @@ func (rs Ressource) Routes(s *fuego.Server) {
 
 	fuego.Post(adminRoutes, "/ingredients/new", rs.adminCreateIngredient)
 	fuego.Get(adminRoutes, "/users", rs.adminRecipes)
-
 }

openapi.go

@@ -108,7 +108,7 @@ func registerOpenAPIRoutes(s *Server, jsonSpec []byte) {
 		_, _ = w.Write(jsonSpec)
 	})
 
-	Handle(s, s.OpenAPIConfig.SwaggerUrl+"/", s.UIHandler(s.OpenAPIConfig.JsonUrl))
+	Handle(s, s.OpenAPIConfig.SwaggerUrl+"/", s.OpenAPIConfig.UIHandler(s.OpenAPIConfig.JsonUrl))
 
 	slog.Info(fmt.Sprintf("JSON spec: http://%s%s", s.Server.Addr, s.OpenAPIConfig.JsonUrl))
 	slog.Info(fmt.Sprintf("OpenAPI UI: http://%s%s/index.html", s.Server.Addr, s.OpenAPIConfig.SwaggerUrl))

openapi_handler_test.go

@@ -0,0 +1,50 @@
+package fuego
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestDefaultOpenAPIHandler(t *testing.T) {
+	t.Run("works with DefaultOpenAPIHandler", func(t *testing.T) {
+		s := NewServer()
+
+		s.OutputOpenAPISpec()
+
+		require.NotNil(t, s.OpenAPIConfig.UIHandler)
+
+		w := httptest.NewRecorder()
+		r := httptest.NewRequest("GET", "/swagger/index.html", nil)
+
+		s.Mux.ServeHTTP(w, r)
+
+		require.Equal(t, 200, w.Code)
+		require.Contains(t, w.Body.String(), "OpenAPI specification")
+		require.Equal(t, "", w.Header().Get("X-Test-Response"))
+	})
+
+	t.Run("wrap DefaultOpenAPIHandler behind a middleware", func(t *testing.T) {
+		s := NewServer(
+			WithOpenAPIConfig(OpenAPIConfig{
+				UIHandler: func(specURL string) http.Handler {
+					return dummyMiddleware(DefaultOpenAPIHandler(specURL))
+				},
+			}),
+		)
+		s.OutputOpenAPISpec()
+
+		require.NotNil(t, s.OpenAPIConfig.UIHandler)
+
+		w := httptest.NewRecorder()
+		r := httptest.NewRequest("GET", "/swagger/index.html", nil)
+
+		s.Mux.ServeHTTP(w, r)
+
+		require.Equal(t, 200, w.Code)
+		require.Contains(t, w.Body.String(), "OpenAPI specification")
+		require.Equal(t, "response", w.Header().Get("X-Test-Response"))
+	})
+}

options.go

@@ -16,17 +16,19 @@ import (
 )
 
 type OpenAPIConfig struct {
-	DisableSwagger   bool   // If true, the server will not serve the swagger ui nor the openapi json spec
-	DisableLocalSave bool   // If true, the server will not save the openapi json spec locally
-	SwaggerUrl       string // URL to serve the swagger ui
-	JsonUrl          string // URL to serve the openapi json spec
-	JsonFilePath     string // Local path to save the openapi json spec
+	DisableSwagger   bool                              // If true, the server will not serve the swagger ui nor the openapi json spec
+	DisableLocalSave bool                              // If true, the server will not save the openapi json spec locally
+	SwaggerUrl       string                            // URL to serve the swagger ui
+	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
 }
 
 var defaultOpenAPIConfig = OpenAPIConfig{
 	SwaggerUrl:   "/swagger",
 	JsonUrl:      "/swagger/openapi.json",
 	JsonFilePath: "doc/openapi.json",
+	UIHandler:    DefaultOpenAPIHandler,
 }
 
 type Server struct {
@@ -47,8 +49,7 @@ type Server struct {
 
 	basePath string
 
-	OpenApiSpec openapi3.T                        // OpenAPI spec generated by the server
-	UIHandler   func(specURL string) http.Handler // Handler to serve the openapi ui from spec url
+	OpenApiSpec openapi3.T // OpenAPI spec generated by the server
 
 	Security Security
 
@@ -89,7 +90,6 @@ func NewServer(options ...func(*Server)) *Server {
 		OpenApiSpec: NewOpenApiSpec(),
 
 		OpenAPIConfig: defaultOpenAPIConfig,
-		UIHandler:     DefaultOpenAPIHandler,
 
 		Security: NewSecurity(),
 	}
@@ -267,18 +267,28 @@ func WithoutLogger() func(*Server) {
 
 func WithOpenAPIConfig(openapiConfig OpenAPIConfig) func(*Server) {
 	return func(s *Server) {
-		s.OpenAPIConfig = openapiConfig
+		if openapiConfig.JsonUrl != "" {
+			s.OpenAPIConfig.JsonUrl = openapiConfig.JsonUrl
+		}
+
+		if openapiConfig.SwaggerUrl != "" {
+			s.OpenAPIConfig.SwaggerUrl = openapiConfig.SwaggerUrl
+		}
+
+		if openapiConfig.JsonFilePath != "" {
+			s.OpenAPIConfig.JsonFilePath = openapiConfig.JsonFilePath
+		}
 
-		if s.OpenAPIConfig.JsonUrl == "" {
-			s.OpenAPIConfig.JsonUrl = defaultOpenAPIConfig.JsonUrl
+		if openapiConfig.UIHandler != nil {
+			s.OpenAPIConfig.UIHandler = openapiConfig.UIHandler
 		}
 
-		if s.OpenAPIConfig.SwaggerUrl == "" {
-			s.OpenAPIConfig.SwaggerUrl = defaultOpenAPIConfig.SwaggerUrl
+		if openapiConfig.DisableSwagger {
+			s.OpenAPIConfig.DisableSwagger = true
 		}
 
-		if s.OpenAPIConfig.JsonFilePath == "" {
-			s.OpenAPIConfig.JsonFilePath = defaultOpenAPIConfig.JsonFilePath
+		if openapiConfig.DisableLocalSave {
+			s.OpenAPIConfig.DisableLocalSave = true
 		}
 
 		if !validateJsonSpecLocalPath(s.OpenAPIConfig.JsonFilePath) {