mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-06-06 21:24:10 +00:00
feat(api-docs): add JSON syntax highlighting and top-right copy button to code blocks
This commit is contained in:
parent
a141b4f457
commit
14604e0c51
3 changed files with 157 additions and 7 deletions
|
|
@ -18,6 +18,7 @@ import AppSidebar from '@/components/AppSidebar.vue';
|
||||||
import { HttpUtil, ClipboardManager } from '@/utils/index.js';
|
import { HttpUtil, ClipboardManager } from '@/utils/index.js';
|
||||||
import { sections as allSections } from './endpoints.js';
|
import { sections as allSections } from './endpoints.js';
|
||||||
import EndpointSection from './EndpointSection.vue';
|
import EndpointSection from './EndpointSection.vue';
|
||||||
|
import CodeBlock from './CodeBlock.vue';
|
||||||
|
|
||||||
const { t } = useI18n();
|
const { t } = useI18n();
|
||||||
|
|
||||||
|
|
@ -182,7 +183,7 @@ onMounted(() => {
|
||||||
</a-card>
|
</a-card>
|
||||||
|
|
||||||
<a-card class="curl-card" size="small" title="Quick example">
|
<a-card class="curl-card" size="small" title="Quick example">
|
||||||
<pre class="code-block">{{ curlExample }}</pre>
|
<CodeBlock :code="curlExample" lang="text" />
|
||||||
</a-card>
|
</a-card>
|
||||||
|
|
||||||
<div class="toolbar">
|
<div class="toolbar">
|
||||||
|
|
|
||||||
152
frontend/src/pages/api-docs/CodeBlock.vue
Normal file
152
frontend/src/pages/api-docs/CodeBlock.vue
Normal file
|
|
@ -0,0 +1,152 @@
|
||||||
|
<script setup>
|
||||||
|
import { computed, ref } from 'vue';
|
||||||
|
import { message } from 'ant-design-vue';
|
||||||
|
import { CopyOutlined, CheckOutlined } from '@ant-design/icons-vue';
|
||||||
|
|
||||||
|
const props = defineProps({
|
||||||
|
code: { type: String, default: '' },
|
||||||
|
lang: { type: String, default: 'json' },
|
||||||
|
});
|
||||||
|
|
||||||
|
const copied = ref(false);
|
||||||
|
|
||||||
|
function escapeHtml(str) {
|
||||||
|
return str.replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>');
|
||||||
|
}
|
||||||
|
|
||||||
|
function highlightJson(str) {
|
||||||
|
const escaped = escapeHtml(str);
|
||||||
|
return escaped.replace(
|
||||||
|
/("(?:[^"\\]|\\.)*")\s*(:)|("(?:[^"\\]|\\.)*")|(-?\d+\.?\d*(?:[eE][+-]?\d+)?)\b|(true|false)|(null)|([{}\[\]])/g,
|
||||||
|
(_m, key, colon, string, number, bool, nil) => {
|
||||||
|
if (colon) return `<span class="json-key">${key}</span>${colon}`;
|
||||||
|
if (string) return `<span class="json-string">${string}</span>`;
|
||||||
|
if (number) return `<span class="json-number">${number}</span>`;
|
||||||
|
if (bool) return `<span class="json-boolean">${bool}</span>`;
|
||||||
|
if (nil) return `<span class="json-null">${nil}</span>`;
|
||||||
|
return _m;
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const highlighted = computed(() => {
|
||||||
|
if (props.lang === 'json') {
|
||||||
|
return highlightJson(props.code);
|
||||||
|
}
|
||||||
|
return escapeHtml(props.code);
|
||||||
|
});
|
||||||
|
|
||||||
|
async function copyCode() {
|
||||||
|
try {
|
||||||
|
await navigator.clipboard.writeText(props.code);
|
||||||
|
copied.value = true;
|
||||||
|
message.success('Copied');
|
||||||
|
setTimeout(() => { copied.value = false; }, 2000);
|
||||||
|
} catch {
|
||||||
|
message.error('Copy failed');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="code-block-wrapper">
|
||||||
|
<button class="copy-btn" :class="{ copied }" @click="copyCode" :title="copied ? 'Copied' : 'Copy'">
|
||||||
|
<CheckOutlined v-if="copied" />
|
||||||
|
<CopyOutlined v-else />
|
||||||
|
</button>
|
||||||
|
<pre class="code-block" :class="`lang-${lang}`"><code v-html="highlighted"></code></pre>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.code-block-wrapper {
|
||||||
|
position: relative;
|
||||||
|
border-radius: 6px;
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
|
||||||
|
.copy-btn {
|
||||||
|
position: absolute;
|
||||||
|
top: 6px;
|
||||||
|
right: 6px;
|
||||||
|
z-index: 1;
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
width: 28px;
|
||||||
|
height: 28px;
|
||||||
|
border: 1px solid rgba(128, 128, 128, 0.2);
|
||||||
|
border-radius: 4px;
|
||||||
|
background: rgba(255, 255, 255, 0.85);
|
||||||
|
color: rgba(0, 0, 0, 0.5);
|
||||||
|
cursor: pointer;
|
||||||
|
font-size: 13px;
|
||||||
|
opacity: 0;
|
||||||
|
transition: opacity 0.15s, background 0.15s, color 0.15s;
|
||||||
|
}
|
||||||
|
|
||||||
|
.code-block-wrapper:hover .copy-btn {
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
.copy-btn:hover {
|
||||||
|
background: #fff;
|
||||||
|
color: #1677ff;
|
||||||
|
border-color: #1677ff;
|
||||||
|
}
|
||||||
|
|
||||||
|
.copy-btn.copied {
|
||||||
|
opacity: 1;
|
||||||
|
background: #52c41a;
|
||||||
|
color: #fff;
|
||||||
|
border-color: #52c41a;
|
||||||
|
}
|
||||||
|
|
||||||
|
.code-block {
|
||||||
|
background: rgba(128, 128, 128, 0.08);
|
||||||
|
border: 1px solid rgba(128, 128, 128, 0.15);
|
||||||
|
border-radius: 6px;
|
||||||
|
padding: 12px;
|
||||||
|
margin: 0;
|
||||||
|
font-family: ui-monospace, SFMono-Regular, Menlo, monospace;
|
||||||
|
font-size: 12.5px;
|
||||||
|
line-height: 1.55;
|
||||||
|
white-space: pre-wrap;
|
||||||
|
word-break: break-word;
|
||||||
|
overflow-x: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
</style>
|
||||||
|
|
||||||
|
<style>
|
||||||
|
.json-key { color: #0550ae; }
|
||||||
|
.json-string { color: #0a3069; }
|
||||||
|
.json-number { color: #0550ae; }
|
||||||
|
.json-boolean { color: #cf222e; }
|
||||||
|
.json-null { color: #8250df; }
|
||||||
|
|
||||||
|
body.dark .code-block {
|
||||||
|
background: rgba(255, 255, 255, 0.04);
|
||||||
|
border-color: rgba(255, 255, 255, 0.1);
|
||||||
|
color: rgba(255, 255, 255, 0.88);
|
||||||
|
}
|
||||||
|
|
||||||
|
body.dark .json-key { color: #79c0ff; }
|
||||||
|
body.dark .json-string { color: #a5d6ff; }
|
||||||
|
body.dark .json-number { color: #79c0ff; }
|
||||||
|
body.dark .json-boolean { color: #ff7b72; }
|
||||||
|
body.dark .json-null { color: #d2a8ff; }
|
||||||
|
|
||||||
|
body.dark .copy-btn {
|
||||||
|
background: rgba(255, 255, 255, 0.08);
|
||||||
|
color: rgba(255, 255, 255, 0.5);
|
||||||
|
border-color: rgba(255, 255, 255, 0.15);
|
||||||
|
}
|
||||||
|
|
||||||
|
body.dark .copy-btn:hover {
|
||||||
|
background: rgba(255, 255, 255, 0.12);
|
||||||
|
color: #58a6ff;
|
||||||
|
border-color: #58a6ff;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
|
@ -1,6 +1,7 @@
|
||||||
<script setup>
|
<script setup>
|
||||||
import { computed } from 'vue';
|
import { computed } from 'vue';
|
||||||
import { methodColors } from './endpoints.js';
|
import { methodColors } from './endpoints.js';
|
||||||
|
import CodeBlock from './CodeBlock.vue';
|
||||||
|
|
||||||
const props = defineProps({
|
const props = defineProps({
|
||||||
endpoint: { type: Object, required: true },
|
endpoint: { type: Object, required: true },
|
||||||
|
|
@ -33,16 +34,12 @@ const paramColumns = [
|
||||||
|
|
||||||
<div v-if="endpoint.body" class="endpoint-block">
|
<div v-if="endpoint.body" class="endpoint-block">
|
||||||
<div class="block-label">Request body</div>
|
<div class="block-label">Request body</div>
|
||||||
<a-typography-paragraph :copyable="{ text: endpoint.body }">
|
<CodeBlock :code="endpoint.body" lang="json" />
|
||||||
<pre class="code-block">{{ endpoint.body }}</pre>
|
|
||||||
</a-typography-paragraph>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div v-if="endpoint.response" class="endpoint-block">
|
<div v-if="endpoint.response" class="endpoint-block">
|
||||||
<div class="block-label">Response</div>
|
<div class="block-label">Response</div>
|
||||||
<a-typography-paragraph :copyable="{ text: endpoint.response }">
|
<CodeBlock :code="endpoint.response" lang="json" />
|
||||||
<pre class="code-block">{{ endpoint.response }}</pre>
|
|
||||||
</a-typography-paragraph>
|
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</template>
|
</template>
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue