gin-swagger
gin-swagger copied to clipboard
swaggo
Indirect dependency using 7MB when compiled
Hey,
First of all, great work. Thanks a lot for the project, it's very useful. However, I've noticed that the project adds at least 15MB to the end executable. So I tried analyzing it using goweight and the result is as follows:
Now the biggest offender is the static files needed for the Swagger UI, but that's normal (more on that in another issue perhaps).
But right afterwards is github.com/ugorji/go, which is marked as an indirect dependancy in go.mod. I also ran a search and found no reference in the imports of the projects.
I believe a little go mod tiny and a new bug fix release would be enough to shave about 7MB from the end executables.
Thanks a lot for the project, and I look forward to perhaps contributing more to it.
Hi.
It's interesting question for me.
I took the tool - https://github.com/KyleBanks/depth and got the dependency tree.
Module github.com/ugorji/go is dependency github.com/gin-gonic/gin.
@AntonDzyk did you mean go mod tidy right?
For both of you, I don't think that indirect dependency can be removed until you stop using gin.
FYI: if you realy want to reduce the binary size , you can fist build the app with -ldflags '-s -w' and instead of importing github.com/swagg/gin-swagger/swaggerFiles that actually embeds the "swagger ui" you can use a index.html file like the following to load the ui and resource over the web.
This file is apart of the same package "docs" , where swagger.json, swagger.yaml and docs.go are generaged.
package docs
import (
"github.com/swaggo/swag"
"log"
"net/http"
"regexp"
)
func Swagger() func(http.ResponseWriter, *http.Request) {
var re = regexp.MustCompile(`^(.*\/)([^\?].*)?[\?|.]*$`)
return func(w http.ResponseWriter, r *http.Request) {
log.Printf("%s", r.RequestURI)
matches := re.FindStringSubmatch(r.RequestURI)
path := matches[2]
switch path {
case "/", "index.html":
w.Header().Add("Content-Type", "text/html")
w.Write([]byte(indexTempl))
case "v1.json":
w.Header().Add("Content-Type", "application/json")
doc, err := swag.ReadDoc()
if err != nil {
w.WriteHeader(http.StatusInternalServerError)
doc = "swagg.ReadDoc error:" + err.Error()
}
w.Write([]byte(doc))
default:
w.WriteHeader(http.StatusNotFound)
w.Write([]byte(http.StatusText(http.StatusNotFound)))
}
return
}
}
const indexTempl = `<!-- 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="//unpkg.com/swagger-ui-dist@3/swagger-ui.css" >
<link rel="icon" type="image/png" href="//unpkg.com/swagger-ui-dist@3/favicon-32x32.png" sizes="32x32" />
<link rel="icon" type="image/png" href="//unpkg.com/swagger-ui-dist@3/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="//unpkg.com/swagger-ui-dist@3/swagger-ui-bundle.js"> </script>
<script src="//unpkg.com/swagger-ui-dist@3/swagger-ui-standalone-preset.js"> </script>
<script>
window.onload = function() {
// Build a system
const ui = SwaggerUIBundle({
url: "v1.json",
dom_id: '#swagger-ui',
validatorUrl: null,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
plugins: [
SwaggerUIBundle.plugins.DownloadUrl
],
layout: "StandaloneLayout"
})
window.ui = ui
}
</script>
</body>
</html>
`
@AntonDzyk Intreseting. I will verify this. Thank you very much. @ubogdan Absolutely. That's one funny typo 😃