mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-07-09 06:06:08 +00:00
MHSanaei
9b91f0f42e
Fold the standalone 3x-ui-docs project (Next.js 16 + Fumadocs, deployed to docs.sanaei.dev) into docs/ so the panel and its documentation share a single source of truth, the way sing-box keeps its docs in-tree. The old repo becomes redundant and can be retired. - Import the full site under docs/ (app, components, content, lib, public, scripts, config). The self-contained pnpm project sits alongside the existing engineering notes with no filename collisions. - Re-point "Edit on GitHub" links from MHSanaei/3x-ui-docs to this repo's docs/content/docs path (docs/lib/shared.ts, docs/app/.../page.tsx). - Add docs-ci.yml and docs-deploy.yml under .github/workflows/, scoped to docs/** and run with working-directory: docs, since GitHub only runs workflows from the repo-root .github/. deploy-static.yml's GitHub Pages publish (CNAME docs.sanaei.dev) carries over unchanged. Follow-up (outside this commit): attach the docs.sanaei.dev custom domain to this repository's Pages (or set the Vercel project's root directory to docs), confirm the site is live from the monorepo, then delete MHSanaei/3x-ui-docs.
50 lines
1.7 KiB
TypeScript
50 lines
1.7 KiB
TypeScript
// Pure builders for 3x-ui panel API requests. The panel exposes every endpoint
|
|
// under /panel/api/* and authenticates with `Authorization: Bearer <token>`
|
|
// (reference/api/authentication). Emits a ready cURL command and a fetch()
|
|
// snippet. No React/DOM imports.
|
|
|
|
export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE';
|
|
|
|
export interface ApiRequestInput {
|
|
baseUrl: string;
|
|
token: string;
|
|
path: string; // e.g. /panel/api/inbounds/list
|
|
method: HttpMethod;
|
|
body?: string; // JSON string, for POST/PUT
|
|
}
|
|
|
|
export function normalizeBase(baseUrl: string): string {
|
|
return baseUrl.trim().replace(/\/+$/, '');
|
|
}
|
|
|
|
export function joinUrl(baseUrl: string, path: string): string {
|
|
const base = normalizeBase(baseUrl);
|
|
const p = path.trim().startsWith('/') ? path.trim() : `/${path.trim()}`;
|
|
return `${base}${p}`;
|
|
}
|
|
|
|
function hasBody(i: ApiRequestInput): boolean {
|
|
return (i.method === 'POST' || i.method === 'PUT') && !!i.body && i.body.trim().length > 0;
|
|
}
|
|
|
|
export function buildCurl(i: ApiRequestInput): string {
|
|
const url = joinUrl(i.baseUrl, i.path);
|
|
const lines = [`curl -X ${i.method} '${url}'`, ` -H 'Authorization: Bearer ${i.token}'`];
|
|
if (hasBody(i)) {
|
|
lines.push(` -H 'Content-Type: application/json'`);
|
|
lines.push(` --data '${i.body!.trim()}'`);
|
|
}
|
|
return lines.join(' \\\n');
|
|
}
|
|
|
|
export function buildFetchSnippet(i: ApiRequestInput): string {
|
|
const url = joinUrl(i.baseUrl, i.path);
|
|
const headers = [`'Authorization': 'Bearer ${i.token}'`];
|
|
if (hasBody(i)) headers.push(`'Content-Type': 'application/json'`);
|
|
|
|
const opts = [`method: '${i.method}'`, `headers: { ${headers.join(', ')} }`];
|
|
if (hasBody(i)) opts.push(`body: JSON.stringify(${i.body!.trim()})`);
|
|
|
|
return `await fetch('${url}', {\n ${opts.join(',\n ')},\n});`;
|
|
}
|