feat: add switch to control swagger (#869)

feat: add switch to control swaager
zincsearch · Apr 25, 2023 · b578ba4 · b578ba4
1 parent 80c04ee
commit b578ba4
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/pkg/config/config.go b/pkg/config/config.go
@@ -56,6 +56,7 @@ type config struct {
 	MaxDocumentSize           int           `env:"ZINC_MAX_DOCUMENT_SIZE,default=1m"`      // Max size for a single document . Default = 1 MB = 1024 * 1024
 	WalSyncInterval           time.Duration `env:"ZINC_WAL_SYNC_INTERVAL,default=1s"`      // sync wal to disk, 1s, 10ms
 	WalRedoLogNoSync          bool          `env:"ZINC_WAL_REDOLOG_NO_SYNC,default=false"` // control sync after every write
+	ZINC_SWAGGER_ENABLE       bool          `env:"ZINC_SWAGGER_ENABLE,default=true"`
 	Cluster                   cluster
 	Shard                     shard
 	Etcd                      etcd

diff --git a/pkg/routes/routes.go b/pkg/routes/routes.go
@@ -29,6 +29,7 @@ import (
 	_ "github.com/zincsearch/zincsearch/docs" // docs is generated by Swag CLI
 
 	"github.com/zincsearch/zincsearch"
+	"github.com/zincsearch/zincsearch/pkg/config"
 	"github.com/zincsearch/zincsearch/pkg/handlers/auth"
 	"github.com/zincsearch/zincsearch/pkg/handlers/document"
 	"github.com/zincsearch/zincsearch/pkg/handlers/index"
@@ -54,11 +55,12 @@ func SetRoutes(r *gin.Engine) {
 	r.GET("/healthz", meta.GetHealthz)
 
 	// use ginSwagger middleware to serve the API docs
-	r.GET("/swagger", func(c *gin.Context) {
-		c.Redirect(http.StatusMovedPermanently, "/swagger/index.html")
-	})
-	r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
-
+	if config.Global.ZINC_SWAGGER_ENABLE {
+		r.GET("/swagger", func(c *gin.Context) {
+			c.Redirect(http.StatusMovedPermanently, "/swagger/index.html")
+		})
+		r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
+	}
 	front, err := zincsearch.GetFrontendAssets()
 	if err != nil {
 		log.Err(err)