2017-06-25 09:09:47 +00:00
|
|
|
package ginSwagger
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"html/template"
|
2018-09-26 02:28:12 +00:00
|
|
|
"os"
|
2017-06-25 09:09:47 +00:00
|
|
|
"regexp"
|
2019-04-03 02:59:18 +00:00
|
|
|
"strings"
|
2017-08-04 03:22:19 +00:00
|
|
|
|
2018-09-26 02:28:12 +00:00
|
|
|
"golang.org/x/net/webdav"
|
|
|
|
|
|
2017-08-04 03:22:19 +00:00
|
|
|
"github.com/gin-gonic/gin"
|
|
|
|
|
"github.com/swaggo/swag"
|
2017-06-25 09:09:47 +00:00
|
|
|
)
|
|
|
|
|
|
2019-03-24 01:56:13 +00:00
|
|
|
// Config stores ginSwagger configuration variables.
|
|
|
|
|
type Config struct {
|
2019-03-29 01:46:37 +00:00
|
|
|
//The url pointing to API definition (normally swagger.json or swagger.yaml). Default is `doc.json`.
|
2019-11-28 05:27:09 +00:00
|
|
|
URL string
|
|
|
|
|
DeepLinking bool
|
2019-03-24 01:56:13 +00:00
|
|
|
}
|
|
|
|
|
|
2019-03-29 01:46:37 +00:00
|
|
|
// URL presents the url pointing to API definition (normally swagger.json or swagger.yaml).
|
|
|
|
|
func URL(url string) func(c *Config) {
|
|
|
|
|
return func(c *Config) {
|
|
|
|
|
c.URL = url
|
|
|
|
|
}
|
2019-03-24 01:56:13 +00:00
|
|
|
}
|
|
|
|
|
|
2019-11-28 05:27:09 +00:00
|
|
|
// DeepLinking set the swagger deeplinking configuration
|
|
|
|
|
func DeepLinking(deepLinking bool) func(c *Config) {
|
|
|
|
|
return func(c *Config) {
|
|
|
|
|
c.DeepLinking = deepLinking
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-08-04 03:25:46 +00:00
|
|
|
// WrapHandler wraps `http.Handler` into `gin.HandlerFunc`.
|
2019-03-29 01:46:37 +00:00
|
|
|
func WrapHandler(h *webdav.Handler, confs ...func(c *Config)) gin.HandlerFunc {
|
|
|
|
|
defaultConfig := &Config{
|
2019-11-28 05:27:09 +00:00
|
|
|
URL: "doc.json",
|
|
|
|
|
DeepLinking: true,
|
2019-03-29 01:46:37 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
for _, c := range confs {
|
|
|
|
|
c(defaultConfig)
|
|
|
|
|
}
|
|
|
|
|
|
2019-03-24 01:56:13 +00:00
|
|
|
return CustomWrapHandler(defaultConfig, h)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// CustomWrapHandler wraps `http.Handler` into `gin.HandlerFunc`
|
|
|
|
|
func CustomWrapHandler(config *Config, h *webdav.Handler) gin.HandlerFunc {
|
2017-06-25 09:09:47 +00:00
|
|
|
//create a template with name
|
|
|
|
|
t := template.New("swagger_index.html")
|
|
|
|
|
index, _ := t.Parse(swagger_index_templ)
|
|
|
|
|
|
2019-03-24 01:56:13 +00:00
|
|
|
var rexp = regexp.MustCompile(`(.*)(index\.html|doc\.json|favicon-16x16\.png|favicon-32x32\.png|/oauth2-redirect\.html|swagger-ui\.css|swagger-ui\.css\.map|swagger-ui\.js|swagger-ui\.js\.map|swagger-ui-bundle\.js|swagger-ui-bundle\.js\.map|swagger-ui-standalone-preset\.js|swagger-ui-standalone-preset\.js\.map)[\?|.]*`)
|
2019-03-23 09:04:42 +00:00
|
|
|
|
2019-03-23 10:16:08 +00:00
|
|
|
return func(c *gin.Context) {
|
2019-03-24 01:56:13 +00:00
|
|
|
|
|
|
|
|
type swaggerUIBundle struct {
|
2019-11-28 05:27:09 +00:00
|
|
|
URL string
|
|
|
|
|
DeepLinking bool
|
2019-03-24 01:56:13 +00:00
|
|
|
}
|
|
|
|
|
|
2017-06-25 09:09:47 +00:00
|
|
|
var matches []string
|
2019-03-24 01:56:13 +00:00
|
|
|
if matches = rexp.FindStringSubmatch(c.Request.RequestURI); len(matches) != 3 {
|
2017-06-25 09:09:47 +00:00
|
|
|
c.Status(404)
|
|
|
|
|
c.Writer.Write([]byte("404 page not found"))
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
path := matches[2]
|
|
|
|
|
prefix := matches[1]
|
|
|
|
|
h.Prefix = prefix
|
|
|
|
|
|
2019-04-03 02:59:18 +00:00
|
|
|
if strings.HasSuffix(path, ".html") {
|
|
|
|
|
c.Header("Content-Type", "text/html; charset=utf-8")
|
|
|
|
|
} else if strings.HasSuffix(path, ".css") {
|
|
|
|
|
c.Header("Content-Type", "text/css; charset=utf-8")
|
|
|
|
|
} else if strings.HasSuffix(path, ".js") {
|
|
|
|
|
c.Header("Content-Type", "application/javascript")
|
|
|
|
|
} else if strings.HasSuffix(path, ".json") {
|
|
|
|
|
c.Header("Content-Type", "application/json")
|
|
|
|
|
}
|
|
|
|
|
|
2017-06-25 09:09:47 +00:00
|
|
|
switch path {
|
2017-06-25 09:23:11 +00:00
|
|
|
case "index.html":
|
2019-03-24 01:56:13 +00:00
|
|
|
index.Execute(c.Writer, &swaggerUIBundle{
|
2019-11-28 05:27:09 +00:00
|
|
|
URL: config.URL,
|
|
|
|
|
DeepLinking: config.DeepLinking,
|
2019-03-24 01:56:13 +00:00
|
|
|
})
|
2017-06-25 09:09:47 +00:00
|
|
|
case "doc.json":
|
2019-02-22 10:16:51 +00:00
|
|
|
doc, err := swag.ReadDoc()
|
|
|
|
|
if err != nil {
|
|
|
|
|
panic(err)
|
|
|
|
|
}
|
2017-07-06 16:57:54 +00:00
|
|
|
c.Writer.Write([]byte(doc))
|
2017-06-25 09:09:47 +00:00
|
|
|
return
|
|
|
|
|
default:
|
|
|
|
|
h.ServeHTTP(c.Writer, c.Request)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2018-09-26 02:28:12 +00:00
|
|
|
// DisablingWrapHandler turn handler off
|
|
|
|
|
// if specified environment variable passed
|
2019-03-23 10:16:08 +00:00
|
|
|
func DisablingWrapHandler(h *webdav.Handler, envName string) gin.HandlerFunc {
|
2018-09-26 02:28:12 +00:00
|
|
|
eFlag := os.Getenv(envName)
|
|
|
|
|
if eFlag != "" {
|
|
|
|
|
return func(c *gin.Context) {
|
|
|
|
|
// Simulate behavior when route unspecified and
|
|
|
|
|
// return 404 HTTP code
|
|
|
|
|
c.String(404, "")
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2019-03-23 10:16:08 +00:00
|
|
|
return WrapHandler(h)
|
2018-09-26 02:28:12 +00:00
|
|
|
}
|
|
|
|
|
|
2019-03-24 01:56:13 +00:00
|
|
|
// DisablingCustomWrapHandler turn handler off
|
|
|
|
|
// if specified environment variable passed
|
|
|
|
|
func DisablingCustomWrapHandler(config *Config, h *webdav.Handler, envName string) gin.HandlerFunc {
|
|
|
|
|
eFlag := os.Getenv(envName)
|
|
|
|
|
if eFlag != "" {
|
|
|
|
|
return func(c *gin.Context) {
|
|
|
|
|
// Simulate behavior when route unspecified and
|
|
|
|
|
// return 404 HTTP code
|
|
|
|
|
c.String(404, "")
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return CustomWrapHandler(config, h)
|
|
|
|
|
}
|
|
|
|
|
|
2017-06-25 09:09:47 +00:00
|
|
|
const swagger_index_templ = `<!-- HTML for static distribution bundle build -->
|
|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="UTF-8">
|
|
|
|
|
<title>Swagger UI</title>
|
|
|
|
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700" rel="stylesheet">
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="./swagger-ui.css" >
|
|
|
|
|
<link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
|
|
|
|
|
<link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
|
|
|
|
|
<style>
|
|
|
|
|
html
|
|
|
|
|
{
|
|
|
|
|
box-sizing: border-box;
|
|
|
|
|
overflow: -moz-scrollbars-vertical;
|
|
|
|
|
overflow-y: scroll;
|
|
|
|
|
}
|
|
|
|
|
*,
|
|
|
|
|
*:before,
|
|
|
|
|
*:after
|
|
|
|
|
{
|
|
|
|
|
box-sizing: inherit;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
body {
|
|
|
|
|
margin:0;
|
|
|
|
|
background: #fafafa;
|
|
|
|
|
}
|
|
|
|
|
</style>
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="position:absolute;width:0;height:0">
|
|
|
|
|
<defs>
|
|
|
|
|
<symbol viewBox="0 0 20 20" id="unlocked">
|
|
|
|
|
<path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V6h2v-.801C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8z"></path>
|
|
|
|
|
</symbol>
|
|
|
|
|
|
|
|
|
|
<symbol viewBox="0 0 20 20" id="locked">
|
|
|
|
|
<path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8zM12 8H8V5.199C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8z"/>
|
|
|
|
|
</symbol>
|
|
|
|
|
|
|
|
|
|
<symbol viewBox="0 0 20 20" id="close">
|
|
|
|
|
<path d="M14.348 14.849c-.469.469-1.229.469-1.697 0L10 11.819l-2.651 3.029c-.469.469-1.229.469-1.697 0-.469-.469-.469-1.229 0-1.697l2.758-3.15-2.759-3.152c-.469-.469-.469-1.228 0-1.697.469-.469 1.228-.469 1.697 0L10 8.183l2.651-3.031c.469-.469 1.228-.469 1.697 0 .469.469.469 1.229 0 1.697l-2.758 3.152 2.758 3.15c.469.469.469 1.229 0 1.698z"/>
|
|
|
|
|
</symbol>
|
|
|
|
|
|
|
|
|
|
<symbol viewBox="0 0 20 20" id="large-arrow">
|
|
|
|
|
<path d="M13.25 10L6.109 2.58c-.268-.27-.268-.707 0-.979.268-.27.701-.27.969 0l7.83 7.908c.268.271.268.709 0 .979l-7.83 7.908c-.268.271-.701.27-.969 0-.268-.269-.268-.707 0-.979L13.25 10z"/>
|
|
|
|
|
</symbol>
|
|
|
|
|
|
|
|
|
|
<symbol viewBox="0 0 20 20" id="large-arrow-down">
|
|
|
|
|
<path d="M17.418 6.109c.272-.268.709-.268.979 0s.271.701 0 .969l-7.908 7.83c-.27.268-.707.268-.979 0l-7.908-7.83c-.27-.268-.27-.701 0-.969.271-.268.709-.268.979 0L10 13.25l7.418-7.141z"/>
|
|
|
|
|
</symbol>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<symbol viewBox="0 0 24 24" id="jump-to">
|
|
|
|
|
<path d="M19 7v4H5.83l3.58-3.59L8 6l-6 6 6 6 1.41-1.41L5.83 13H21V7z"/>
|
|
|
|
|
</symbol>
|
|
|
|
|
|
|
|
|
|
<symbol viewBox="0 0 24 24" id="expand">
|
|
|
|
|
<path d="M10 18h4v-2h-4v2zM3 6v2h18V6H3zm3 7h12v-2H6v2z"/>
|
|
|
|
|
</symbol>
|
|
|
|
|
|
|
|
|
|
</defs>
|
|
|
|
|
</svg>
|
|
|
|
|
|
|
|
|
|
<div id="swagger-ui"></div>
|
|
|
|
|
|
|
|
|
|
<script src="./swagger-ui-bundle.js"> </script>
|
|
|
|
|
<script src="./swagger-ui-standalone-preset.js"> </script>
|
|
|
|
|
<script>
|
|
|
|
|
window.onload = function() {
|
|
|
|
|
// Build a system
|
|
|
|
|
const ui = SwaggerUIBundle({
|
2019-03-24 01:56:13 +00:00
|
|
|
url: "{{.URL}}",
|
2017-06-25 09:09:47 +00:00
|
|
|
dom_id: '#swagger-ui',
|
|
|
|
|
validatorUrl: null,
|
|
|
|
|
presets: [
|
|
|
|
|
SwaggerUIBundle.presets.apis,
|
|
|
|
|
SwaggerUIStandalonePreset
|
|
|
|
|
],
|
|
|
|
|
plugins: [
|
|
|
|
|
SwaggerUIBundle.plugins.DownloadUrl
|
|
|
|
|
],
|
2019-11-28 05:27:09 +00:00
|
|
|
layout: "StandaloneLayout",
|
|
|
|
|
deepLinking: {{.DeepLinking}}
|
2017-06-25 09:09:47 +00:00
|
|
|
})
|
|
|
|
|
|
|
|
|
|
window.ui = ui
|
|
|
|
|
}
|
|
|
|
|
</script>
|
|
|
|
|
</body>
|
|
|
|
|
|
|
|
|
|
</html>
|
|
|
|
|
`
|
