GitHub-Mirror/huma
2
0
Fork 0
mirror of https://github.com/Fishwaldo/huma.git synced 2025-03-17 12:21:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

instead of templates, use functions

Browse source
This commit is contained in:
David Weiser 2020-08-19 11:26:55 -07:00
parent 7f278d5904
commit 3073099192
2 changed files with 30 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
docs.go
View file

@ -22,7 +22,7 @@ func splitDocs(docs string) (title, desc string) {
// RapiDocTemplate is the template used to generate the RapiDoc. It needs two args to render:
// 1. the title
// 2. the path to the openapi.yaml file
var RapiDocTemplate = `<!doctype html>
var rapiDocTemplate = `<!doctype html>
<html>
<head>
<title>%s</title>
@ -43,7 +43,7 @@ var RapiDocTemplate = `<!doctype html>
// ReDocTemplate is the template used to generate the RapiDoc. It needs two args to render:
// 1. the title
// 2. the path to the openapi.yaml file
var ReDocTemplate = `<!DOCTYPE html>
var reDocTemplate = `<!DOCTYPE html>
<html>
<head>
<title>%s</title>
@ -58,7 +58,7 @@ var ReDocTemplate = `<!DOCTYPE html>
</body>
</html>`
var SwaggerUITemplate = `<!-- HTML for static distribution bundle build -->
var swaggerUITemplate = `<!-- HTML for static distribution bundle build -->
<!DOCTYPE html>
<html lang="en">
<head>
@ -117,23 +117,44 @@ var SwaggerUITemplate = `<!-- HTML for static distribution bundle build -->
</body>
</html>`
// RapiDocString generates the RapiDoc. It needs two args to render:
// 1. the title
// 2. the path to the openapi.yaml file
func RapiDocString(pageTitle, openapiPath string) string {
return fmt.Sprintf(rapiDocTemplate, pageTitle, openapiPath)
}
// ReDocString generates the RapiDoc. It needs two args to render:
// 1. the title
// 2. the path to the openapi.yaml file
func ReDocString(pageTitle, openapiPath string) string {
return fmt.Sprintf(reDocTemplate, pageTitle, openapiPath)
}
// SwaggerUIDocString generates the RapiDoc. It needs two args to render:
// 1. the title
// 2. the path to the openapi.yaml file
func SwaggerUIDocString(pageTitle, openapiPath string) string {
return fmt.Sprintf(swaggerUITemplate, pageTitle, openapiPath)
}
// RapiDocHandler renders documentation using RapiDoc.
func RapiDocHandler(pageTitle string) Handler {
return func(c *gin.Context) {
c.Data(200, "text/html", []byte(fmt.Sprintf(RapiDocTemplate, pageTitle, "/openapi.json")))
c.Data(200, "text/html", []byte(RapiDocString(pageTitle, "/openapi.json")))
}
}
// ReDocHandler renders documentation using ReDoc.
func ReDocHandler(pageTitle string) Handler {
return func(c *gin.Context) {
c.Data(200, "text/html", []byte(fmt.Sprintf(ReDocTemplate, pageTitle, "/openapi.json")))
c.Data(200, "text/html", []byte(ReDocString(pageTitle, "/openapi.json")))
}
}
// SwaggerUIHandler renders documentation using Swagger UI.
func SwaggerUIHandler(pageTitle string) Handler {
return func(c *gin.Context) {
c.Data(200, "text/html", []byte(fmt.Sprintf(SwaggerUITemplate, pageTitle, "/openapi.json")))
c.Data(200, "text/html", []byte(SwaggerUIDocString(pageTitle, "/openapi.json")))
}
}

6
router.go
View file

@ -392,11 +392,11 @@ func NewRouter(docs, version string, options ...RouterOption) *Router {
docsPayload := ""
switch r.docsDomType {
case "rapi":
docsPayload = fmt.Sprintf(RapiDocTemplate, title, openapiJsonPath)
docsPayload = RapiDocString(title, openapiJsonPath)
case "swagger":
docsPayload = fmt.Sprintf(SwaggerUITemplate, title, openapiJsonPath)
docsPayload = SwaggerUIDocString(title, openapiJsonPath)
case "redoc":
docsPayload = fmt.Sprintf(ReDocTemplate, title, openapiJsonPath)
docsPayload = ReDocString(title, openapiJsonPath)
}
c.Data(200, "text/html", []byte(docsPayload))
})