2021-10-03 00:22:06 +08:00
|
|
|
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
|
|
|
|
|
//
|
|
|
|
|
// This Source Code Form is subject to the terms of the MIT License.
|
|
|
|
|
// If a copy of the MIT was not distributed with this file,
|
|
|
|
|
// You can obtain one at https://github.com/gogf/gf.
|
|
|
|
|
|
|
|
|
|
package ghttp
|
|
|
|
|
|
|
|
|
|
import (
|
2021-10-11 21:41:56 +08:00
|
|
|
"github.com/gogf/gf/v2/text/gstr"
|
2021-10-03 00:22:06 +08:00
|
|
|
)
|
|
|
|
|
|
|
|
|
|
const (
|
2022-03-04 11:36:05 +08:00
|
|
|
swaggerUIDocName = `redoc.standalone.js`
|
|
|
|
|
swaggerUIDocNamePlaceHolder = `{SwaggerUIDocName}`
|
|
|
|
|
swaggerUIDocURLPlaceHolder = `{SwaggerUIDocUrl}`
|
|
|
|
|
swaggerUITemplate = `
|
2022-03-01 11:43:42 +08:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<title>API Reference</title>
|
|
|
|
|
<meta charset="utf-8"/>
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
|
|
|
<style>
|
|
|
|
|
body {
|
|
|
|
|
margin: 0;
|
|
|
|
|
padding: 0;
|
|
|
|
|
}
|
|
|
|
|
</style>
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
2022-03-04 11:36:05 +08:00
|
|
|
<redoc spec-url="{SwaggerUIDocUrl}"></redoc>
|
|
|
|
|
<script src="{SwaggerUIDocName}"> </script>
|
2022-03-01 11:43:42 +08:00
|
|
|
</body>
|
|
|
|
|
</html>
|
|
|
|
|
`
|
2021-10-03 00:22:06 +08:00
|
|
|
)
|
|
|
|
|
|
|
|
|
|
// swaggerUI is a build-in hook handler for replace default swagger json URL to local openapi json file path.
|
|
|
|
|
// This handler makes sense only if the openapi specification automatic producing configuration is enabled.
|
|
|
|
|
func (s *Server) swaggerUI(r *Request) {
|
|
|
|
|
if s.config.OpenApiPath == "" {
|
|
|
|
|
return
|
|
|
|
|
}
|
2022-03-01 11:43:42 +08:00
|
|
|
if r.StaticFile != nil && r.StaticFile.File != nil && r.StaticFile.IsDir {
|
2022-03-04 11:36:05 +08:00
|
|
|
content := gstr.ReplaceByMap(swaggerUITemplate, map[string]string{
|
|
|
|
|
swaggerUIDocURLPlaceHolder: s.config.OpenApiPath,
|
|
|
|
|
swaggerUIDocNamePlaceHolder: gstr.TrimRight(r.GetUrl(), "/") + "/" + swaggerUIDocName,
|
|
|
|
|
})
|
|
|
|
|
r.Response.Write(content)
|
2021-10-03 00:22:06 +08:00
|
|
|
r.ExitAll()
|
|
|
|
|
}
|
|
|
|
|
}
|
