gitea/modules/markup/external/openapi.go at 2a198b0b04635a1eb563870febbceedb28ea4b86 · go-gitea/gitea · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
// Copyright 2026 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT

package external

import (
	"fmt"
	"html"
	"io"

	"code.gitea.io/gitea/modules/markup"
	"code.gitea.io/gitea/modules/public"
	"code.gitea.io/gitea/modules/setting"
	"code.gitea.io/gitea/modules/util"
)

type openAPIRenderer struct{}

var (
	_ markup.PostProcessRenderer = (*openAPIRenderer)(nil)
	_ markup.ExternalRenderer    = (*openAPIRenderer)(nil)
)

func (p *openAPIRenderer) Name() string {
	return "openapi"
}

func (p *openAPIRenderer) NeedPostProcess() bool {
	return false
}

func (p *openAPIRenderer) FileNamePatterns() []string {
	return []string{
		"openapi.yaml",
		"openapi.yml",
		"openapi.json",
		"swagger.yaml",
		"swagger.yml",
		"swagger.json",
	}
}

func (p *openAPIRenderer) SanitizerRules() []setting.MarkupSanitizerRule {
	return nil
}

func (p *openAPIRenderer) GetExternalRendererOptions() (ret markup.ExternalRendererOptions) {
	ret.SanitizerDisabled = true
	ret.DisplayInIframe = true
	ret.ContentSandbox = ""
	return ret
}

func (p *openAPIRenderer) Render(ctx *markup.RenderContext, input io.Reader, output io.Writer) error {
	content, err := util.ReadWithLimit(input, int(setting.UI.MaxDisplayFileSize))
	if err != nil {
		return err
	}
	// TODO: can extract this to a tmpl file later
	_, err = io.WriteString(output, fmt.Sprintf(
		`<!DOCTYPE html>
<html>
<head>
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="%s/assets/%s">
</head>
<body>
	<div id="swagger-ui"><textarea class="swagger-spec-content" data-spec-filename="%s">%s</textarea></div>
	<script type="module" src="%s/assets/%s"></script>
</body>
</html>`,
		setting.StaticURLPrefix,
		public.GetAssetPath("css/swagger.css"),
		html.EscapeString(ctx.RenderOptions.RelativePath),
		html.EscapeString(util.UnsafeBytesToString(content)),
		setting.StaticURLPrefix,
		public.GetAssetPath("js/swagger.js"),
	))
	return err
}