feat: add disabling handler (#33)

2018-09-26 05:28:12 +03:00
parent 6192cec7d2
commit 6f4fdc3ec4
3 changed files with 96 additions and 1 deletions
@@ -75,3 +75,44 @@ func main() {

 ![swagger_index.html](https://user-images.githubusercontent.com/8943871/31943004-dd08a10e-b88c-11e7-9e77-19d2c759a586.png)

+6. If you want to disable swagger when some environment variable is set, use `DisablingWrapHandler`
+
+### Example with disabling:
+
+```go
+package main
+
+import (
+	"github.com/gin-gonic/gin"
+	"github.com/swaggo/gin-swagger"
+	"github.com/swaggo/gin-swagger/swaggerFiles"
+
+	_ "./docs" // docs is generated by Swag CLI, you have to import it.
+)
+
+// @title Swagger Example API
+// @version 1.0
+// @description This is a sample server Petstore server.
+// @termsOfService http://swagger.io/terms/
+
+// @contact.name API Support
+// @contact.url http://www.swagger.io/support
+// @contact.email support@swagger.io
+
+// @license.name Apache 2.0
+// @license.url http://www.apache.org/licenses/LICENSE-2.0.html
+
+// @host petstore.swagger.io
+// @BasePath /v2
+func main() {
+	r := gin.New()
+    
+    // use ginSwagger middleware to 
+	r.GET("/swagger/*any", ginSwagger.DisablingWrapHandler(swaggerFiles.Handler, "NAME_OF_ENV_VARIABLE"))
+
+	r.Run()
+}
+```
+
+Then, if you set envioment variable `NAME_OF_ENV_VARIABLE` to anything, `/swagger/*any`
+will respond 404, just like when route unspecified.