Abdalrahman
6e12329d9d
* feat(api-docs): enhance API documentation with missing endpoints, search, collapse, and route sync test - Add 29 undocumented routes across 4 new sections (Settings, Xray Settings, Subscription Server, WebSocket) plus 4 missing Server API endpoints - Fix inaccuracies: history metric keys, node metric keys, VLESS enc description - Add response schemas to 15+ key endpoints - Add search bar and expand/collapse all controls to the docs page - Add collapsible endpoint sections with endpoint count - Add Go test (TestAPIRoutesDocumented) to verify all Go routes are documented * feat(api-docs): add JSON syntax highlighting and top-right copy button to code blocks * fix(api-docs): use distinct colors for JSON syntax highlighting (green strings, amber numbers) * feat(api-docs): add request body examples, error responses, WebSocket message types, and subscription response headers * fix(api-docs): use ClipboardManager.copyText instead of copy to fix API token copy button
139 lines
3.3 KiB
Vue
139 lines
3.3 KiB
Vue
<script setup>
|
|
import { computed } from 'vue';
|
|
import { methodColors, safeInlineHtml } from './endpoints.js';
|
|
import CodeBlock from './CodeBlock.vue';
|
|
|
|
const props = defineProps({
|
|
endpoint: { type: Object, required: true },
|
|
});
|
|
|
|
const tagColor = computed(() => methodColors[props.endpoint.method] || 'default');
|
|
const hasParams = computed(() => Array.isArray(props.endpoint.params) && props.endpoint.params.length > 0);
|
|
|
|
const paramColumns = [
|
|
{ title: 'Name', dataIndex: 'name', key: 'name', width: 180 },
|
|
{ title: 'In', dataIndex: 'in', key: 'in', width: 100 },
|
|
{ title: 'Type', dataIndex: 'type', key: 'type', width: 120 },
|
|
{ title: 'Description', dataIndex: 'desc', key: 'desc' },
|
|
];
|
|
</script>
|
|
|
|
<template>
|
|
<div class="endpoint-row">
|
|
<div class="endpoint-header">
|
|
<a-tag :color="tagColor" class="method-tag">{{ endpoint.method }}</a-tag>
|
|
<code class="endpoint-path">{{ endpoint.path }}</code>
|
|
</div>
|
|
|
|
<p v-if="endpoint.summary" class="endpoint-summary" v-html="safeInlineHtml(endpoint.summary)"></p>
|
|
|
|
<div v-if="hasParams" class="endpoint-block">
|
|
<div class="block-label">Parameters</div>
|
|
<a-table :columns="paramColumns" :data-source="endpoint.params" :pagination="false" size="small" row-key="name" />
|
|
</div>
|
|
|
|
<div v-if="endpoint.body" class="endpoint-block">
|
|
<div class="block-label">Request body</div>
|
|
<CodeBlock :code="endpoint.body" lang="json" />
|
|
</div>
|
|
|
|
<div v-if="endpoint.response" class="endpoint-block">
|
|
<div class="block-label">Response</div>
|
|
<CodeBlock :code="endpoint.response" lang="json" />
|
|
</div>
|
|
|
|
<div v-if="endpoint.errorResponse" class="endpoint-block">
|
|
<div class="block-label error-label">Error response</div>
|
|
<CodeBlock :code="endpoint.errorResponse" lang="json" />
|
|
</div>
|
|
</div>
|
|
</template>
|
|
|
|
<style scoped>
|
|
.endpoint-row {
|
|
padding: 12px 0;
|
|
}
|
|
|
|
.endpoint-row + .endpoint-row {
|
|
border-top: 1px solid rgba(128, 128, 128, 0.15);
|
|
}
|
|
|
|
.endpoint-header {
|
|
display: flex;
|
|
align-items: center;
|
|
gap: 10px;
|
|
flex-wrap: wrap;
|
|
}
|
|
|
|
.method-tag {
|
|
font-weight: 600;
|
|
font-family: ui-monospace, SFMono-Regular, Menlo, monospace;
|
|
letter-spacing: 0.5px;
|
|
min-width: 60px;
|
|
text-align: center;
|
|
}
|
|
|
|
.endpoint-path {
|
|
font-family: ui-monospace, SFMono-Regular, Menlo, monospace;
|
|
font-size: 13px;
|
|
word-break: break-all;
|
|
}
|
|
|
|
.endpoint-summary {
|
|
margin: 8px 0 0;
|
|
color: rgba(0, 0, 0, 0.65);
|
|
line-height: 1.55;
|
|
}
|
|
|
|
.endpoint-block {
|
|
margin-top: 12px;
|
|
}
|
|
|
|
.block-label {
|
|
font-size: 12px;
|
|
font-weight: 600;
|
|
text-transform: uppercase;
|
|
letter-spacing: 0.5px;
|
|
color: rgba(0, 0, 0, 0.5);
|
|
margin-bottom: 6px;
|
|
}
|
|
|
|
.error-label {
|
|
color: #cf222e;
|
|
}
|
|
|
|
.code-block {
|
|
background: rgba(128, 128, 128, 0.08);
|
|
border: 1px solid rgba(128, 128, 128, 0.15);
|
|
border-radius: 6px;
|
|
padding: 10px 12px;
|
|
font-family: ui-monospace, SFMono-Regular, Menlo, monospace;
|
|
font-size: 12.5px;
|
|
line-height: 1.55;
|
|
margin: 0;
|
|
white-space: pre-wrap;
|
|
word-break: break-word;
|
|
overflow-x: auto;
|
|
}
|
|
</style>
|
|
|
|
<style>
|
|
body.dark .endpoint-summary {
|
|
color: rgba(255, 255, 255, 0.7);
|
|
}
|
|
|
|
body.dark .block-label {
|
|
color: rgba(255, 255, 255, 0.55);
|
|
}
|
|
|
|
body.dark .error-label {
|
|
color: #ff7b72;
|
|
}
|
|
|
|
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);
|
|
}
|
|
</style>
|