perf: adjust middleware

Author: rookie-luochao

.github/workflows/ci.yaml

@@ -6,6 +6,8 @@ on:
   pull_request:
     branches:
       - main
+  workflow_dispatch:
+  
 permissions:
   contents: read
 jobs:

Makefile

@@ -1,23 +1,37 @@
-.PHONY: all lint test deps
+.PHONY: all deps golangci-lint
 
-DOC_PATH=assets/openapi-ui.umd.js
-DOC_URL=https://cdn.jsdelivr.net/npm/openapi-ui-dist@latest/lib/openapi-ui.umd.js
+DOC_PATH=pkg/doc/assets/openapi-ui.umd.js
+DOC_URL=https://unpkg.com/openapi-ui-dist@latest/lib/openapi-ui.umd.js
 
-run-echo:
-	cd _examples/echo && go run .
+all: download lint test
 
-all: $(DOC_PATH) lint test
+download:
+	curl -sL -o $(DOC_PATH) $(DOC_URL)
 
 lint:
 	go fmt ./...
 	go vet ./...
-	golangci-lint run ./...
 
 test:
 	go test -race ./...
 
 deps:
 	go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
+	
+golangci-lint:
+	golangci-lint run ./...
 
-$(DOC_PATH):
-	curl -sL -o $(DOC_PATH) $(DOC_URL)
+run-echo:
+	cd _examples/echo && go run .
+
+run-fiber:
+	cd _examples/fiber && go run .
+
+run-gin:
+	cd _examples/gin && go run .
+
+run-gorilla:
+	cd _examples/gorilla && go run .
+
+run-http:
+	cd _examples/http && go run .

README.md

@@ -4,12 +4,12 @@
 
 The template is based on the OpenAPI-UI [bundle.js](https://github.com/rookie-luochao/openapi-ui/blob/master/lib/openapi-ui.umd.js) with the script already placed in the html instead of depending on a CDN.
 
-This package does not generate openapi spec file. Check [this example](_examples/gen) for using code generation with swag.
+This package does not generate openapi spec file. Check [this example](https://github.com/swaggo/swag/tree/master/example) for using code generation with swag.
 
 ## Usage
 
 ```go
-import "github.com/rookie-luochao/go-openapi-ui"
+import "github.com/rookie-luochao/go-openapi-ui/pkg/doc"
 
 ...
 
@@ -27,7 +27,7 @@ doc := doc.Doc{
 ```go
 import (
 	"net/http"
-	"github.com/rookie-luochao/go-openapi-ui"
+	"github.com/rookie-luochao/go-openapi-ui/pkg/doc"
 )
 
 ...
@@ -40,8 +40,8 @@ http.ListenAndServe(address, doc.Handler())
 ```go
 import (
 	"github.com/gin-gonic/gin"
-	"github.com/rookie-luochao/go-openapi-ui"
-	ginopenapiui "github.com/rookie-luochao/go-openapi-ui/gin"
+	"github.com/rookie-luochao/go-openapi-ui/pkg/doc"
+	ginopenapiui "github.com/rookie-luochao/go-openapi-ui/pkg/middleware/gin"
 )
 
 ...
@@ -55,8 +55,8 @@ r.Use(ginopenapiui.New(doc))
 ```go
 import (
 	"github.com/labstack/echo/v4"
-	"github.com/rookie-luochao/go-openapi-ui"
-	echoopenapiui "github.com/rookie-luochao/go-openapi-ui/echo"
+	"github.com/rookie-luochao/go-openapi-ui/pkg/doc"
+	echoopenapiui "github.com/rookie-luochao/go-openapi-ui/pkg/middleware/echo"
 )
 
 ...
@@ -70,8 +70,8 @@ r.Use(echoopenapiui.New(doc))
 ```go
 import (
 	"github.com/gofiber/fiber/v2"
-	"github.com/rookie-luochao/go-openapi-ui"
-	fiberopenapiui "github.com/rookie-luochao/go-openapi-ui/fiber"
+	"github.com/rookie-luochao/go-openapi-ui/pkg/doc"
+	fiberopenapiui "github.com/rookie-luochao/go-openapi-ui/pkg/middleware/fiber"
 )
 
 ...
@@ -82,7 +82,7 @@ r.Use(fiberopenapiui.New(doc))
 
 See [examples](/_examples)
 
-## 致谢
+## Thanks
 
 - [go-redoc](https://github.com/mvrilo/go-redoc)
 

_examples/echo/main.go

@@ -2,10 +2,11 @@ package main
 
 import (
 	"fmt"
+	"os"
+
 	"github.com/labstack/echo/v4"
 	"github.com/rookie-luochao/go-openapi-ui/pkg/doc"
-	middleware_echo "github.com/rookie-luochao/go-openapi-ui/pkg/middleware/echo"
-	"os"
+	echoopenapiui "github.com/rookie-luochao/go-openapi-ui/pkg/middleware/echo"
 )
 
 func main() {
@@ -22,7 +23,7 @@ func main() {
 	}
 
 	r := echo.New()
-	r.Use(middleware_echo.New(doc))
+	r.Use(echoopenapiui.New(doc))
 
 	println("Documentation served at http://127.0.0.1:8000/docs")
 	panic(r.Start(":8000"))

_examples/fiber/go.mod

@@ -2,8 +2,8 @@ package main
 
 import (
 	"github.com/gofiber/fiber/v2"
-	fiberredoc "github.com/rookie-luochao/go-openapi-ui/fiber"
 	"github.com/rookie-luochao/go-openapi-ui/pkg/doc"
+	fiberopenapiui "github.com/rookie-luochao/go-openapi-ui/pkg/middleware/fiber"
 )
 
 func main() {
@@ -16,7 +16,7 @@ func main() {
 	}
 
 	r := fiber.New()
-	r.Use(fiberredoc.New(doc))
+	r.Use(fiberopenapiui.New(doc))
 
 	println("Documentation served at http://127.0.0.1:8000/docs")
 	panic(r.Listen(":8000"))