diff --git a/README.md b/README.md index e4f016a..65e8fdf 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ And import following in your code: ```go import "github.com/swaggo/gin-swagger" // gin-swagger middleware -import "github.com/swaggo/gin-swagger/swaggerFiles" // swagger embed files +import "github.com/swaggo/files" // swagger embed files ``` @@ -41,8 +41,8 @@ package main import ( "github.com/gin-gonic/gin" + "github.com/swaggo/files" "github.com/swaggo/gin-swagger" - "github.com/swaggo/gin-swagger/swaggerFiles" _ "./docs" // docs is generated by Swag CLI, you have to import it. ) @@ -63,12 +63,9 @@ import ( // @BasePath /v2 func main() { r := gin.New() - - config := &ginSwagger.Config{ - URL: "http://localhost:8080/swagger/doc.json", //The url pointing to API definition - } - // use ginSwagger middleware to - r.GET("/swagger/*any", ginSwagger.CustomWrapHandler(config, swaggerFiles.Handler)) + + url := ginSwagger.URL("http://localhost:8080/swagger/doc.json") // The url pointing to API definition + r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler, url)) r.Run() } @@ -76,7 +73,7 @@ func main() { 5. Run it, and browser to http://localhost:8080/swagger/index.html, you can see Swagger 2.0 Api documents. -![swagger_index.html](https://user-images.githubusercontent.com/8943871/31943004-dd08a10e-b88c-11e7-9e77-19d2c759a586.png) +![swagger_index.html](https://user-images.githubusercontent.com/8943871/60704329-b7ab0680-9f36-11e9-9184-5c638c05e9c5.png) 6. If you want to disable swagger when some environment variable is set, use `DisablingWrapHandler` @@ -87,9 +84,9 @@ package main import ( "github.com/gin-gonic/gin" + "github.com/swaggo/files" "github.com/swaggo/gin-swagger" - "github.com/swaggo/gin-swagger/swaggerFiles" - + _ "./docs" // docs is generated by Swag CLI, you have to import it. ) diff --git a/example/basic/main.go b/example/basic/main.go index 05052ec..95bd678 100644 --- a/example/basic/main.go +++ b/example/basic/main.go @@ -2,8 +2,8 @@ package main import ( "github.com/gin-gonic/gin" + "github.com/swaggo/files" "github.com/swaggo/gin-swagger" - "github.com/swaggo/gin-swagger/swaggerFiles" _ "github.com/swaggo/gin-swagger/example/basic/docs" ) @@ -25,7 +25,7 @@ import ( func main() { r := gin.New() - url := ginSwagger.URL("http://localhost:8080/swagger/doc.json") //The url pointing to API definition + url := ginSwagger.URL("http://localhost:8080/swagger/doc.json") // The url pointing to API definition r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler, url)) r.Run() diff --git a/example/gzipped/main.go b/example/gzipped/main.go index 8e4463e..fd3f7e7 100644 --- a/example/gzipped/main.go +++ b/example/gzipped/main.go @@ -3,8 +3,8 @@ package main import ( "github.com/gin-contrib/gzip" "github.com/gin-gonic/gin" + "github.com/swaggo/files" "github.com/swaggo/gin-swagger" - "github.com/swaggo/gin-swagger/swaggerFiles" _ "github.com/swaggo/gin-swagger/example/basic/docs" ) @@ -28,7 +28,7 @@ func main() { r.Use(gzip.Gzip(gzip.BestSpeed)) - url := ginSwagger.URL("http://localhost:8080/swagger/doc.json") //The url pointing to API definition + url := ginSwagger.URL("http://localhost:8080/swagger/doc.json") // The url pointing to API definition r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler, url)) r.Run()