Skip to content

feat: add global server URL configuration to debug pages #21

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
shalousun merged 2 commits into from
Jul 11, 2026
Merged

feat: add global server URL configuration to debug pages #21

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
c4fda5c
feat: add global server URL configuration to debug pages
shalousun Jul 11, 2026
6149c45
chore: replace GITHUB_TOKEN with ORG_CHECKOUT_TOKEN for cross-repo ac…
shalousun Jul 11, 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
6 changes: 3 additions & 3 deletions .github/workflows/build-and-run-example-project.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ jobs:
uses: actions/checkout@v5
with:
repository: smart-doc-group/smart-doc-maven-plugin
token: ${{ secrets.GITHUB_TOKEN }}
token: ${{ secrets.ORG_CHECKOUT_TOKEN }}

- name: Set up JDK 8
uses: actions/setup-java@v5
Expand Down Expand Up @@ -133,7 +133,7 @@ jobs:
uses: actions/checkout@v5
with:
repository: smart-doc-group/smart-doc-example-cn
token: ${{ secrets.GITHUB_TOKEN }}
token: ${{ secrets.ORG_CHECKOUT_TOKEN }}

- name: Set up JDK 17
uses: actions/setup-java@v5
Expand Down Expand Up @@ -262,7 +262,7 @@ jobs:
uses: actions/checkout@v5
with:
repository: smart-doc-group/smart-doc-example-cn
token: ${{ secrets.GITHUB_TOKEN }}
token: ${{ secrets.ORG_CHECKOUT_TOKEN }}

- name: Set up JDK 17
uses: actions/setup-java@v5
Expand Down
44 changes: 42 additions & 2 deletions src/main/resources/template/debug-all.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,39 @@
.hljs {
padding: 0
}</style>
<style>
#server-url-row {
display: flex;
align-items: center;
margin-bottom: 20px;
}
#server-url-row strong {
margin-right: 10px;
font-size: 14px;
}
#smart-doc-server-url {
flex: 1;
max-width: 400px;
padding: 6px 4px;
border: 0;
background: transparent;
font-size: 14px;
color: #333;
outline: none;
transition: background 0.2s;
cursor: text;
}
#smart-doc-server-url:hover {
background: #f5f5f5;
}
#smart-doc-server-url:focus {
background: #fafafa;
}
#smart-doc-server-url::placeholder {
color: #ccc;
font-style: italic;
}
</style>
<script src="highlight.min.js"></script>
<script src="jquery.min.js"></script>
</head>
Expand Down Expand Up @@ -88,7 +121,14 @@
</ul>
</div>
</div>
<div id="content"><%if(isNotEmpty(revisionLogList)){%>
<div id="content">
<div id="server-url-row">
<strong>Server URL:</strong>
<input id="smart-doc-server-url" type="text"
placeholder="http://localhost:8080"
title="Click to edit server address"/>
</div>
<%if(isNotEmpty(revisionLogList)){%>
<div id="preamble">
<div class="sectionbody">
<table class="tableblock frame-all grid-all spread">
Expand Down Expand Up @@ -137,7 +177,7 @@
class="line-through">${htmlEscape(doc.desc)}</span></a><%}else{%><a class="link" href="#${doc.methodId}"><%if(!apiDocListOnlyHasDefaultGroup){%>${apiGroup.order}.${api.order}.${doc.order}.&nbsp;${htmlEscape(doc.desc)}<%}else{%>${api.order}.${doc.order}.&nbsp;${htmlEscape(doc.desc)}<%}%></a><%}%>
</h3>
<div class="paragraph" id="${doc.methodId}-url" data-url="${doc.url}" data-download="${doc.download}"
data-page="${doc.page}"><p><strong>URL:</strong><a href="${doc.url}" class="bare">&nbsp;${doc.url}</a></p>
data-page="${doc.page}"><p><strong>URL:</strong><a href="${doc.url}" class="bare">&nbsp;${doc.path}</a></p>
</div>
<div class="paragraph" id="${doc.methodId}-method" data-method="${doc.type}"><p><strong>Type:</strong>&nbsp;${doc.type}
</p></div>
Expand Down
41 changes: 40 additions & 1 deletion src/main/resources/template/html/debug.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,39 @@
.hljs {
padding: 0em
}</style>
<style>
#server-url-row {
display: flex;
align-items: center;
margin-bottom: 20px;
}
#server-url-row strong {
margin-right: 10px;
font-size: 14px;
}
#smart-doc-server-url {
flex: 1;
max-width: 400px;
padding: 6px 4px;
border: 0;
background: transparent;
font-size: 14px;
color: #333;
outline: none;
transition: background 0.2s;
cursor: text;
}
#smart-doc-server-url:hover {
background: #f5f5f5;
}
#smart-doc-server-url:focus {
background: #fafafa;
}
#smart-doc-server-url::placeholder {
color: #ccc;
font-style: italic;
}
</style>
<script src="highlight.min.js"></script>
<script src="jquery.min.js"></script>
</head>
Expand Down Expand Up @@ -63,6 +96,12 @@
</div>
</div>
<div id="content">
<div id="server-url-row">
<strong>Server URL:</strong>
<input id="smart-doc-server-url" type="text"
placeholder="http://localhost:8080"
title="Click to edit server address"/>
</div>
<div class="sect1"><h2 id="_${desc}"><a class="anchor" href="#_${desc}"></a><a class="link" href="#_${desc}">${order}.&nbsp;${desc}</a>
</h2>
<div class="sectionbody"><%for(doc in list){%>
Expand All @@ -73,7 +112,7 @@
href="#_${order}_${doc.order}_${doc.desc}">${order}.${doc.order}.&nbsp;${htmlEscape(doc.desc)}</a><%}%>
</h3>
<div class="paragraph" data-download="${doc.download}" data-page="${doc.page}" data-url="${doc.url}"
id="${doc.methodId}-url"><p><strong>URL:</strong><a class="bare" href="${doc.url}">&nbsp;${doc.url}</a></p>
id="${doc.methodId}-url"><p><strong>URL:</strong><a class="bare" href="${doc.url}">&nbsp;${doc.path}</a></p>
</div>
<div class="paragraph" data-method="${doc.type}" id="${doc.methodId}-method"><p><strong>Type:</strong>&nbsp;${doc.type}
</p></div>
Expand Down
41 changes: 39 additions & 2 deletions src/main/resources/template/js/debug.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,43 @@ $("[contenteditable=plaintext-only]").on('blur', function (e) {
const highlightedCode = hljs.highlight('json', content).value;
$this.html(highlightedCode);
})
// Server URL management
const SERVER_URL_STORAGE_KEY = 'smart-doc-server-url';

function getServerUrl() {
var $input = $('#smart-doc-server-url');
if ($input.length && $input.val().trim()) {
return $input.val().trim().replace(/\/+$/, '');
}
return '';
}

function resolveUrl(originalUrl) {
var serverUrl = getServerUrl();
if (!serverUrl || !originalUrl) return originalUrl;
// originalUrl may contain multiple URLs separated by semicolon
return originalUrl.split(';').map(function (u) {
u = u.trim();
if (!u) return u;
try {
var parsed = new URL(u);
return serverUrl + parsed.pathname + parsed.search + parsed.hash;
} catch (e) {
return serverUrl + '/' + u.replace(/^\//, '');
}
}).join(';');
}

$(function () {
var savedUrl = localStorage.getItem(SERVER_URL_STORAGE_KEY);
if (savedUrl) {
$('#smart-doc-server-url').val(savedUrl);
}
$('#smart-doc-server-url').on('change input', function () {
localStorage.setItem(SERVER_URL_STORAGE_KEY, $(this).val().trim());
});
});

$("button").on("click", function () {
const $this = $(this);
const id = $this.data("id");
Expand All @@ -58,9 +95,9 @@ $("button").on("click", function () {
// query param
const $queryElement = $("#" + id + "-query-params")
let $urlDataElement = $("#" + id + "-url");
const url = $urlDataElement.data("url");
const url = resolveUrl($urlDataElement.data("url"));
const isDownload = $urlDataElement.data("download");
const page = $urlDataElement.data("page");
const page = resolveUrl($urlDataElement.data("page"));
const method = $("#" + id + "-method").data("method");
const contentType = $("#" + id + "-content-type").data("content-type");
console.log("request-headers=>" + JSON.stringify(headersData))
Expand Down
Loading