Support rendering OpenAPI spec (#36449)

Fix #20852
2026-01-26 10:34:38 +08:00
parent 89bfddc5c2
commit 4c8f6dfa4e
27 changed files with 322 additions and 177 deletions
@@ -21,10 +21,9 @@ import (

 // RegisterRenderers registers all supported third part renderers according settings
 func RegisterRenderers() {
+	markup.RegisterRenderer(&openAPIRenderer{})
 	for _, renderer := range setting.ExternalMarkupRenderers {
-		if renderer.Enabled && renderer.Command != "" && len(renderer.FileExtensions) > 0 {
-			markup.RegisterRenderer(&Renderer{renderer})
-		}
+		markup.RegisterRenderer(&Renderer{renderer})
 	}
 }

@@ -38,22 +37,18 @@ var (
 	_ markup.ExternalRenderer    = (*Renderer)(nil)
 )

-// Name returns the external tool name
 func (p *Renderer) Name() string {
 	return p.MarkupName
 }

-// NeedPostProcess implements markup.Renderer
 func (p *Renderer) NeedPostProcess() bool {
 	return p.MarkupRenderer.NeedPostProcess
 }

-// Extensions returns the supported extensions of the tool
-func (p *Renderer) Extensions() []string {
-	return p.FileExtensions
+func (p *Renderer) FileNamePatterns() []string {
+	return p.FilePatterns
 }

-// SanitizerRules implements markup.Renderer
 func (p *Renderer) SanitizerRules() []setting.MarkupSanitizerRule {
 	return p.MarkupSanitizerRules
 }
@@ -0,0 +1,79 @@
+// 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/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/css/swagger.css?v=%s">
+</head>
+<body>
+	<div id="swagger-ui"><textarea class="swagger-spec-content" data-spec-filename="%s">%s</textarea></div>
+	<script src="%s/assets/js/swagger.js?v=%s"></script>
+</body>
+</html>`,
+		setting.StaticURLPrefix,
+		setting.AssetVersion,
+		html.EscapeString(ctx.RenderOptions.RelativePath),
+		html.EscapeString(util.UnsafeBytesToString(content)),
+		setting.StaticURLPrefix,
+		setting.AssetVersion,
+	))
+	return err
+}