Merge remote-tracking branch 'upstream/master' into add-oauth-config

swaggo · May 30, 2022 · e5ac771 · e5ac771
2 parents 57d78e6 + 80f04ba
commit e5ac771
Show file tree

Hide file tree

Showing 11 changed files with 740 additions and 451 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,24 @@
+name: build
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        go: [ '1.15.x', '1.16.x', '1.17.x', '1.18.x' ]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Set up Go
+        uses: actions/setup-go@v1
+        with:
+          go-version: ${{ matrix.go }}
+      - name: test
+        run: go test -coverprofile=coverage.txt -covermode=atomic
+      - name: coverage
+        run: bash <(curl -s https://codecov.io/bash)
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,17 @@
+# Binaries for programs and plugins
+*.exe
+*.dll
+*.so
+*.dylib
+
+# Test binary, build with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+dist
+
+.idea
+vendor
+.envrc
+
diff --git a/.goreleaser.yml b/.goreleaser.yml
@@ -0,0 +1,10 @@
+builds:
+  - skip: true
+snapshot:
+  name_template: "{{ .Tag }}-next"
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - '^docs:'
+      - '^test:'
diff --git a/.travis.yml b/.travis.yml
diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,8 @@
+**Describe the PR**
+e.g. add cool parser.
+
+**Relation issue**
+e.g. https://github.com/swaggo/gin-swagger/pull/123/files
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/README.md b/README.md
@@ -2,9 +2,10 @@
 
 echo middleware to automatically generate RESTful API documentation with Swagger 2.0.
 
-[![Travis branch](https://img.shields.io/travis/swaggo/echo-swagger/master.svg)](https://travis-ci.org/swaggo/echo-swagger)
+[![Build Status](https://github.com/swaggo/echo-swagger/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/features/actions)
 [![Codecov branch](https://img.shields.io/codecov/c/github/swaggo/echo-swagger/master.svg)](https://codecov.io/gh/swaggo/echo-swagger)
 [![Go Report Card](https://goreportcard.com/badge/github.com/swaggo/echo-swagger)](https://goreportcard.com/report/github.com/swaggo/echo-swagger)
+[![Release](https://img.shields.io/github/release/swaggo/echo-swagger.svg?style=flat-square)](https://github.com/swaggo/echo-swagger/releases)
 
 
 ## Usage
@@ -13,7 +14,10 @@ echo middleware to automatically generate RESTful API documentation with Swagger
 1. Add comments to your API source code, [See Declarative Comments Format](https://github.com/swaggo/swag#declarative-comments-format).
 2. Download [Swag](https://github.com/swaggo/swag) for Go by using:
 ```sh
-$ go get github.com/swaggo/swag/cmd/swag
+$ go get -d github.com/swaggo/swag/cmd/swag
+
+# 1.16 or newer
+$ go install github.com/swaggo/swag/cmd/swag@latest
 ```
 3. Run the [Swag](https://github.com/swaggo/swag) in your Go project root folder which contains `main.go` file, [Swag](https://github.com/swaggo/swag) will parse comments and generate required files(`docs` folder and `docs/doc.go`).
 ```sh_ "github.com/swaggo/echo-swagger/v2/example/docs"
@@ -69,3 +73,17 @@ func main() {
 
 ![swagger_index.html](https://user-images.githubusercontent.com/8943871/36250587-40834072-1279-11e8-8bb7-02a2e2fdd7a7.png)
 
+Note: If you are using Gzip middleware you should add the swagger endpoint to skipper
+
+### Example
+
+```
+e.Use(middleware.GzipWithConfig(middleware.GzipConfig{
+		Skipper: func(c echo.Context) bool {
+			if strings.Contains(c.Request().URL.Path, "swagger") {
+				return true
+			}
+			return false
+		},
+	}))
+```
diff --git a/example/docs/docs.go b/example/docs/docs.go
@@ -1,18 +1,15 @@
-// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
-// This file was generated by swaggo/swag at
-// 2018-01-12 18:44:40.928256 +0800 CST m=+0.272034118
-
+// Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
+// This file was generated by swaggo/swag
 package docs
 
-import (
-	"github.com/swaggo/swag"
-)
+import "github.com/swaggo/swag"
 
-var doc = `{
+const docTemplate_swagger = `{
+    "schemes": {{ marshal .Schemes }},
     "swagger": "2.0",
     "info": {
-        "description": "This is a sample server Petstore server.",
-        "title": "Swagger Example API",
+        "description": "{{escape .Description}}",
+        "title": "{{.Title}}",
         "termsOfService": "http://swagger.io/terms/",
         "contact": {
             "name": "API Support",
@@ -23,214 +20,25 @@ var doc = `{
             "name": "Apache 2.0",
             "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
         },
-        "version": "1.0"
-    },
-    "host": "petstore.swagger.io",
-    "basePath": "/v2",
-    "paths": {
-        "/file/upload": {
-            "post": {
-                "description": "Upload file",
-                "consumes": [
-                    "multipart/form-data"
-                ],
-                "produces": [
-                    "application/json"
-                ],
-                "summary": "Upload file",
-                "operationId": "file.upload",
-                "parameters": [
-                    {
-                        "type": "file",
-                        "description": "this is a test file",
-                        "name": "file",
-                        "in": "formData",
-                        "required": true
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "description": "ok",
-                        "schema": {
-                            "type": "string"
-                        }
-                    },
-                    "400": {
-                        "description": "We need ID!!",
-                        "schema": {
-                            "type": "object",
-                            "$ref": "#/definitions/web.APIError"
-                        }
-                    },
-                    "404": {
-                        "description": "Can not find ID",
-                        "schema": {
-                            "type": "object",
-                            "$ref": "#/definitions/web.APIError"
-                        }
-                    }
-                }
-            }
-        },
-        "/testapi/get-string-by-int/{some_id}": {
-            "get": {
-                "description": "get string by ID",
-                "consumes": [
-                    "application/json"
-                ],
-                "produces": [
-                    "application/json"
-                ],
-                "summary": "Add a new pet to the store",
-                "operationId": "get-string-by-int",
-                "parameters": [
-                    {
-                        "type": "int",
-                        "description": "Some ID",
-                        "name": "some_id",
-                        "in": "path",
-                        "required": true
-                    },
-                    {
-                        "description": "Some ID",
-                        "name": "some_id",
-                        "in": "body",
-                        "required": true,
-                        "schema": {
-                            "type": "object",
-                            "$ref": "#/definitions/web.Pet"
-                        }
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "description": "ok",
-                        "schema": {
-                            "type": "string"
-                        }
-                    },
-                    "400": {
-                        "description": "We need ID!!",
-                        "schema": {
-                            "type": "object",
-                            "$ref": "#/definitions/web.APIError"
-                        }
-                    },
-                    "404": {
-                        "description": "Can not find ID",
-                        "schema": {
-                            "type": "object",
-                            "$ref": "#/definitions/web.APIError"
-                        }
-                    }
-                }
-            }
-        },
-        "/testapi/get-struct-array-by-string/{some_id}": {
-            "get": {
-                "description": "get struct array by ID",
-                "consumes": [
-                    "application/json"
-                ],
-                "produces": [
-                    "application/json"
-                ],
-                "operationId": "get-struct-array-by-string",
-                "parameters": [
-                    {
-                        "type": "string",
-                        "description": "Some ID",
-                        "name": "some_id",
-                        "in": "path",
-                        "required": true
-                    },
-                    {
-                        "type": "int",
-                        "description": "Offset",
-                        "name": "offset",
-                        "in": "query",
-                        "required": true
-                    },
-                    {
-                        "type": "int",
-                        "description": "Offset",
-                        "name": "limit",
-                        "in": "query",
-                        "required": true
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "description": "ok",
-                        "schema": {
-                            "type": "string"
-                        }
-                    },
-                    "400": {
-                        "description": "We need ID!!",
-                        "schema": {
-                            "type": "object",
-                            "$ref": "#/definitions/web.APIError"
-                        }
-                    },
-                    "404": {
-                        "description": "Can not find ID",
-                        "schema": {
-                            "type": "object",
-                            "$ref": "#/definitions/web.APIError"
-                        }
-                    }
-                }
-            }
-        }
+        "version": "{{.Version}}"
     },
-    "definitions": {
-        "web.APIError": {
-            "type": "object",
-            "properties": {
-                "CreatedAt": {
-                    "type": "string",
-                    "format": "date-time"
-                },
-                "ErrorCode": {
-                    "type": "integer"
-                },
-                "ErrorMessage": {
-                    "type": "string"
-                }
-            }
-        },
-        "web.Pet": {
-            "type": "object",
-            "properties": {
-                "Category": {
-                    "type": "object"
-                },
-                "ID": {
-                    "type": "integer"
-                },
-                "Name": {
-                    "type": "string"
-                },
-                "PhotoUrls": {
-                    "type": "array"
-                },
-                "Status": {
-                    "type": "string"
-                },
-                "Tags": {
-                    "type": "array"
-                }
-            }
-        }
-    }
+    "host": "{{.Host}}",
+    "basePath": "{{.BasePath}}",
+    "paths": {}
 }`
 
-type s struct{}
-
-func (s *s) ReadDoc() string {
-	return doc
+// SwaggerInfo_swagger holds exported Swagger Info so clients can modify it
+var SwaggerInfo_swagger = &swag.Spec{
+	Version:          "1.0",
+	Host:             "petstore.swagger.io",
+	BasePath:         "/v2",
+	Schemes:          []string{},
+	Title:            "Swagger Example API",
+	Description:      "This is a sample server Petstore server.",
+	InfoInstanceName: "swagger",
+	SwaggerTemplate:  docTemplate_swagger,
 }
+
 func init() {
-	swag.Register(swag.Name, &s{})
+	swag.Register(SwaggerInfo_swagger.InstanceName(), SwaggerInfo_swagger)
 }