Skip to content

fix: authenticates swagger ui to access secured endpoints #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
semmet95 merged 2 commits into from
May 29, 2026
Merged

fix: authenticates swagger ui to access secured endpoints #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6300885
refactor: moves swagger ui html code to a separate file and embeds it
semmet95 May 29, 2026
282e5bd
feat: improves swagger ui auth ux
semmet95 May 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions api/source-score.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -522,6 +522,7 @@ components:
required: true
schema:
type: string
default: swagger-ui
description: Client identifier for authentication

schemas:
Expand Down
147 changes: 147 additions & 0 deletions pkg/handlers/swagger-ui.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="UTF-8" />
<title>Source Score API Documentation</title>
<link rel="stylesheet" type="text/css" href="https://unpkg.com/swagger-ui-dist@5.18.2/swagger-ui.css"
integrity="sha384-rcbEi6xgdPk0iWkAQzT2F3FeBJXdG+ydrawGlfHAFIZG7wU6aKbQaRewysYpmrlW" crossorigin="anonymous" />
<style>
html {
box-sizing: border-box;
overflow: -moz-scrollbars-vertical;
overflow-y: scroll;
}

*,
*:before,
*:after {
box-sizing: inherit;
}

body {
margin: 0;
padding: 0;
}
</style>
</head>

<body>
<div id="swagger-ui"></div>

<script src="https://unpkg.com/swagger-ui-dist@5.18.2/swagger-ui-bundle.js"
integrity="sha384-NXtFPpN61oWCuN4D42K6Zd5Rt2+uxeIT36R7kpXBuY9tLnZorzrJ4ykpqwJfgjpZ"
crossorigin="anonymous"></script>
<script src="https://unpkg.com/swagger-ui-dist@5.18.2/swagger-ui-standalone-preset.js"
integrity="sha384-qr68CD0cvHa88PmVu7e1a58Ego4qvKtcvcLdS2a8Mo5zILI01gyIV9jVwJk7X2NU"
crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/js-yaml/4.1.0/js-yaml.min.js"
integrity="sha384-+pxiN6T7yvpryuJmE1gM9PX7yQit15auDb+ZwwvJOd/4be2Cie5/IuVXgQb/S9du"
crossorigin="anonymous" referrerpolicy="no-referrer"></script>
Comment thread
semmet95 marked this conversation as resolved.
<script>
window.onload = async function () {
const AutoAuthorizePlugin = function (system) {
return {
wrapComponents: {
authorizeBtn: () => function AuthorizeBtnOverride(props) {
const React = system.React;

const handleClick = async () => {
try {
const res = await fetch("/auth/token", {
method: "POST",
headers: {
"Client-ID": "swagger-ui"
}
});

if (!res.ok) {
throw new Error("token request failed: " + res.status);
}

const data = await res.json();
const token = data.token;

if (!token) {
throw new Error("no token found in response");
}

window.ui.preauthorizeApiKey("BearerAuth", token);

const btn = document.querySelector(".auth-wrapper .authorize");
if (btn) {
btn.classList.remove("unlocked");
btn.classList.add("locked");
btn.setAttribute("aria-label", "Authorized");
btn.title = "Authorized";
}
} catch (err) {
console.error(err);
alert("Authorization failed: " + err.message);
}
};
Comment thread
semmet95 marked this conversation as resolved.

const isAuthorized =
document.querySelector(".auth-wrapper .authorize.locked") !== null;

return React.createElement(
"button",
{
type: "button",
className: isAuthorized
? "btn authorize locked"
: "btn authorize unlocked",
onClick: handleClick,
title: isAuthorized ? "Authorized" : "Authorize",
"aria-label": isAuthorized ? "Authorized" : "Authorize"
},
"Authorize"
);
}
}
};
};

try {
const res = await fetch("/swagger/spec");
if (!res.ok) {
throw new Error("failed to load swagger spec: " + res.status);
}

const yamlText = await res.text();
const spec = jsyaml.load(yamlText);

if (spec.paths && spec.paths["/auth/token"]) {
delete spec.paths["/auth/token"];
}

window.ui = SwaggerUIBundle({
spec: spec,
dom_id: "#swagger-ui",
requestInterceptor: (req) => {
if (req.url.includes("/auth/token")) {
req.headers["Client-ID"] = "swagger-ui";
}
return req;
},
deepLinking: true,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
plugins: [
SwaggerUIBundle.plugins.DownloadUrl,
AutoAuthorizePlugin
],
layout: "StandaloneLayout"
});
} catch (err) {
console.error(err);
document.getElementById("swagger-ui").innerHTML =
Comment thread
semmet95 marked this conversation as resolved.
"<div style='padding:20px;font-family:sans-serif;color:#b00020;'>Failed to load Swagger UI</div>";
}
};
</script>
</body>

</html>
55 changes: 6 additions & 49 deletions pkg/handlers/swagger.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package handlers

import (
_ "embed"
"net/http"

"github.com/gin-gonic/gin"
Expand All @@ -10,6 +11,11 @@ type SwaggerHandler struct {
specFile []byte
}

var (
//go:embed "swagger-ui.html"
html string
)

func NewSwaggerHandler(specFile []byte) *SwaggerHandler {
return &SwaggerHandler{
specFile: specFile,
Expand All @@ -21,54 +27,5 @@ func (h *SwaggerHandler) ServeSpec(c *gin.Context) {
}

func (h *SwaggerHandler) ServeUI(c *gin.Context) {
html := `<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Source Score API Documentation</title>
<link
rel="stylesheet"
type="text/css"
href="https://unpkg.com/swagger-ui-dist@5.18.2/swagger-ui.css"
integrity="sha384-rcbEi6xgdPk0iWkAQzT2F3FeBJXdG+ydrawGlfHAFIZG7wU6aKbQaRewysYpmrlW"
crossorigin="anonymous"
>
<style>
html { box-sizing: border-box; overflow: -moz-scrollbars-vertical; overflow-y: scroll; }
*, *:before, *:after { box-sizing: inherit; }
body { margin:0; padding:0; }
</style>
</head>
<body>
<div id="swagger-ui"></div>
<script
src="https://unpkg.com/swagger-ui-dist@5.18.2/swagger-ui-bundle.js"
integrity="sha384-NXtFPpN61oWCuN4D42K6Zd5Rt2+uxeIT36R7kpXBuY9tLnZorzrJ4ykpqwJfgjpZ"
crossorigin="anonymous"
></script>
<script
src="https://unpkg.com/swagger-ui-dist@5.18.2/swagger-ui-standalone-preset.js"
integrity="sha384-qr68CD0cvHa88PmVu7e1a58Ego4qvKtcvcLdS2a8Mo5zILI01gyIV9jVwJk7X2NU"
crossorigin="anonymous"
></script>
<script>
window.onload = function() {
window.ui = SwaggerUIBundle({
url: "/swagger/spec",
dom_id: '#swagger-ui',
deepLinking: true,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
plugins: [
SwaggerUIBundle.plugins.DownloadUrl
],
layout: "StandaloneLayout"
});
};
</script>
</body>
</html>`
c.Data(http.StatusOK, "text/html; charset=utf-8", []byte(html))
}
Loading