chore: fix typos

hertz-contrib · Jun 3, 2022 · 0d223c3 · 0d223c3
1 parent ae312cc
commit 0d223c3
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Hertz-swagger
 
-hertz middleware to automatically generate RESTful API documentation with Swagger 2.0.
+Hertz middleware to automatically generate RESTful API documentation with Swagger 2.0.
 
 ## Usage
 
@@ -94,7 +94,7 @@ import (
 	"context"
 	"github.com/cloudwego/hertz/pkg/app"
 	"github.com/cloudwego/hertz/pkg/app/server"
-	hertzSwagger "github.com/hertz-contrib/swagger"
+	swagger "github.com/hertz-contrib/swagger"
 	_ "github.com/hertz-contrib/swagger/example/basic/docs"
 	swaggerFiles "github.com/swaggo/files"
 )
@@ -129,8 +129,8 @@ func main() {
 
 	h.GET("/ping", PingHandler)
 
-	url := hertzSwagger.URL("http://localhost:8888/swagger/doc.json") // The url pointing to API definition
-	h.GET("/swagger/*any", hertzSwagger.WrapHandler(swaggerFiles.Handler, url))
+	url := swagger.URL("http://localhost:8888/swagger/doc.json") // The url pointing to API definition
+	h.GET("/swagger/*any", swagger.WrapHandler(swaggerFiles.Handler, url))
 
 	h.Spin()
 }

diff --git a/example/basic/main.go b/example/basic/main.go
@@ -33,7 +33,7 @@ import (
 
 	"github.com/cloudwego/hertz/pkg/app"
 	"github.com/cloudwego/hertz/pkg/app/server"
-	hertzSwagger "github.com/hertz-contrib/swagger"
+	swagger "github.com/hertz-contrib/swagger"
 	_ "github.com/hertz-contrib/swagger/example/basic/docs"
 	swaggerFiles "github.com/swaggo/files"
 )
@@ -68,8 +68,8 @@ func main() {
 
 	h.GET("/ping", PingHandler)
 
-	url := hertzSwagger.URL("http://localhost:8888/swagger/doc.json") // The url pointing to API definition
-	h.GET("/swagger/*any", hertzSwagger.WrapHandler(swaggerFiles.Handler, url))
+	url := swagger.URL("http://localhost:8888/swagger/doc.json") // The url pointing to API definition
+	h.GET("/swagger/*any", swagger.WrapHandler(swaggerFiles.Handler, url))
 
 	h.Spin()
 }
diff --git a/swagger.go b/swagger.go
@@ -26,7 +26,7 @@
  * Modifications are Copyright 2022 CloudWeGo Authors.
  */
 
-package hertzSwagger
+package swagger
 
 import (
 	"bytes"

diff --git a/swagger_test.go b/swagger_test.go
@@ -26,21 +26,19 @@
  * Modifications are Copyright 2022 CloudWeGo Authors.
  */
 
-package hertzSwagger
+package swagger
 
 import (
 	"io/ioutil"
 	"net/http"
 	"testing"
 
 	"github.com/cloudwego/hertz/pkg/common/config"
+	"github.com/cloudwego/hertz/pkg/common/test/assert"
 	"github.com/cloudwego/hertz/pkg/common/ut"
 	"github.com/cloudwego/hertz/pkg/route"
-
-	"github.com/swaggo/swag"
-
-	"github.com/cloudwego/hertz/pkg/common/test/assert"
 	swaggerFiles "github.com/swaggo/files"
+	"github.com/swaggo/swag"
 )
 
 type mockedSwag struct{}