orion/filecodebox
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
36fe69e2a7abd98b32f6da15f95be2feee0340f7
filecodebox/docs/.vitepress/dist/en/api/index.html
T
Lan 36fe69e2a7 feat: docs
2025-02-12 14:27:39 +08:00

94 lines
44 KiB
Python
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>FileCodeBox API Documentation | FileCodeBox</title>
<meta name="description" content="Simple and efficient file sharing tool">
<meta name="generator" content="VitePress v1.6.3">
<link rel="preload stylesheet" href="/assets/style.8SUn7xXl.css" as="style">
<link rel="preload stylesheet" href="/vp-icons.css" as="style">
<script type="module" src="/assets/app._8rCwCso.js"></script>
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="modulepreload" href="/assets/chunks/theme.BNBC0yme.js">
<link rel="modulepreload" href="/assets/chunks/framework.BmLMQRXF.js">
<link rel="modulepreload" href="/assets/en_api_index.md.DowD_P4F.lean.js">
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
</head>
<body>
<div id="app"><div class="Layout" data-v-b6c923d7><!--[--><!--]--><!--[--><span tabindex="-1" data-v-efe7d6be></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-efe7d6be>Skip to content</a><!--]--><!----><header class="VPNav" data-v-b6c923d7 data-v-b6ac2530><div class="VPNavBar" data-v-b6ac2530 data-v-79868b1d><div class="wrapper" data-v-79868b1d><div class="container" data-v-79868b1d><div class="title" data-v-79868b1d><div class="VPNavBarTitle has-sidebar" data-v-79868b1d data-v-0c6c2dd6><a class="title" href="/en/" data-v-0c6c2dd6><!--[--><!--]--><!--[--><img class="VPImage logo" src="/logo_small.png" alt data-v-1499dcbc><!--]--><span data-v-0c6c2dd6>FileCodeBox</span><!--[--><!--]--></a></div></div><div class="content" data-v-79868b1d><div class="content-body" data-v-79868b1d><!--[--><!--]--><div class="VPNavBarSearch search" data-v-79868b1d><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-79868b1d data-v-28279947><span id="main-nav-aria-label" class="visually-hidden" data-v-28279947> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/en/" tabindex="0" data-v-28279947 data-v-ee14b6c7><!--[--><span data-v-ee14b6c7>Home</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/en/guide/getting-started.html" tabindex="0" data-v-28279947 data-v-ee14b6c7><!--[--><span data-v-ee14b6c7>Guide</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink active" href="/en/api/" tabindex="0" data-v-28279947 data-v-ee14b6c7><!--[--><span data-v-ee14b6c7>API</span><!--]--></a><!--]--><!--[--><div class="VPFlyout VPNavBarMenuGroup" data-v-28279947 data-v-839a11df><button type="button" class="button" aria-haspopup="true" aria-expanded="false" data-v-839a11df><span class="text" data-v-839a11df><!----><span data-v-839a11df>More</span><span class="vpi-chevron-down text-icon" data-v-839a11df></span></span></button><div class="menu" data-v-839a11df><div class="VPMenu" data-v-839a11df data-v-2b491744><div class="items" data-v-2b491744><!--[--><!--[--><div class="VPMenuLink" data-v-2b491744 data-v-b04e260a><a class="VPLink link" href="/en/changelog.html" data-v-b04e260a><!--[--><span data-v-b04e260a>Changelog</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-2b491744 data-v-b04e260a><a class="VPLink link" href="/en/contributing.html" data-v-b04e260a><!--[--><span data-v-b04e260a>Contributing</span><!--]--></a></div><!--]--><!--]--></div><!--[--><!--]--></div></div></div><!--]--><!--]--></nav><div class="VPFlyout VPNavBarTranslations translations" data-v-79868b1d data-v-adf6da57 data-v-839a11df><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="切换语言" data-v-839a11df><span class="text" data-v-839a11df><span class="vpi-languages option-icon" data-v-839a11df></span><!----><span class="vpi-chevron-down text-icon" data-v-839a11df></span></span></button><div class="menu" data-v-839a11df><div class="VPMenu" data-v-839a11df data-v-2b491744><!----><!--[--><!--[--><div class="items" data-v-adf6da57><p class="title" data-v-adf6da57>English</p><!--[--><div class="VPMenuLink" data-v-adf6da57 data-v-b04e260a><a class="VPLink link" href="/api/" data-v-b04e260a><!--[--><span data-v-b04e260a>简体中文</span><!--]--></a></div><!--]--></div><!--]--><!--]--></div></div></div><div class="VPNavBarAppearance appearance" data-v-79868b1d data-v-7e6f0956><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-7e6f0956 data-v-2fc9caea data-v-8e683565><span class="check" data-v-8e683565><span class="icon" data-v-8e683565><!--[--><span class="vpi-sun sun" data-v-2fc9caea></span><span class="vpi-moon moon" data-v-2fc9caea></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-79868b1d data-v-91a2f046 data-v-607f35a4><!--[--><a class="VPSocialLink no-icon" href="https://github.com/vastsa/FileCodeBox" aria-label="github" target="_blank" rel="noopener" data-v-607f35a4 data-v-84a70180><span class="vpi-social-github"></span></a><!--]--></div><div class="VPFlyout VPNavBarExtra extra" data-v-79868b1d data-v-c6f77877 data-v-839a11df><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-839a11df><span class="vpi-more-horizontal icon" data-v-839a11df></span></button><div class="menu" data-v-839a11df><div class="VPMenu" data-v-839a11df data-v-2b491744><!----><!--[--><!--[--><div class="group translations" data-v-c6f77877><p class="trans-title" data-v-c6f77877>English</p><!--[--><div class="VPMenuLink" data-v-c6f77877 data-v-b04e260a><a class="VPLink link" href="/api/" data-v-b04e260a><!--[--><span data-v-b04e260a>简体中文</span><!--]--></a></div><!--]--></div><div class="group" data-v-c6f77877><div class="item appearance" data-v-c6f77877><p class="label" data-v-c6f77877>Appearance</p><div class="appearance-action" data-v-c6f77877><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-c6f77877 data-v-2fc9caea data-v-8e683565><span class="check" data-v-8e683565><span class="icon" data-v-8e683565><!--[--><span class="vpi-sun sun" data-v-2fc9caea></span><span class="vpi-moon moon" data-v-2fc9caea></span><!--]--></span></span></button></div></div></div><div class="group" data-v-c6f77877><div class="item social-links" data-v-c6f77877><div class="VPSocialLinks social-links-list" data-v-c6f77877 data-v-607f35a4><!--[--><a class="VPSocialLink no-icon" href="https://github.com/vastsa/FileCodeBox" aria-label="github" target="_blank" rel="noopener" data-v-607f35a4 data-v-84a70180><span class="vpi-social-github"></span></a><!--]--></div></div></div><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-79868b1d data-v-ab6fcae6><span class="container" data-v-ab6fcae6><span class="top" data-v-ab6fcae6></span><span class="middle" data-v-ab6fcae6></span><span class="bottom" data-v-ab6fcae6></span></span></button></div></div></div></div><div class="divider" data-v-79868b1d><div class="divider-line" data-v-79868b1d></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-b6c923d7 data-v-3ab135ad><div class="container" data-v-3ab135ad><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-3ab135ad><span class="vpi-align-left menu-icon" data-v-3ab135ad></span><span class="menu-text" data-v-3ab135ad>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-3ab135ad data-v-b4822720><button data-v-b4822720>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-b6c923d7 data-v-4cb10d83><div class="curtain" data-v-4cb10d83></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-4cb10d83><span class="visually-hidden" id="sidebar-aria-label" data-v-4cb10d83> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-f4a843d6><section class="VPSidebarItem level-0" data-v-f4a843d6 data-v-074d9f77><div class="item" role="button" tabindex="0" data-v-074d9f77><div class="indicator" data-v-074d9f77></div><h2 class="text" data-v-074d9f77>API Reference</h2><!----></div><div class="items" data-v-074d9f77><!--[--><div class="VPSidebarItem level-1 is-link" data-v-074d9f77 data-v-074d9f77><div class="item" data-v-074d9f77><div class="indicator" data-v-074d9f77></div><a class="VPLink link link" href="/en/api/#share-api" data-v-074d9f77><!--[--><p class="text" data-v-074d9f77>Share API</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-074d9f77 data-v-074d9f77><div class="item" data-v-074d9f77><div class="indicator" data-v-074d9f77></div><a class="VPLink link link" href="/en/api/#admin-api" data-v-074d9f77><!--[--><p class="text" data-v-074d9f77>Admin API</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-074d9f77 data-v-074d9f77><div class="item" data-v-074d9f77><div class="indicator" data-v-074d9f77></div><a class="VPLink link link" href="/en/api/#error-response" data-v-074d9f77><!--[--><p class="text" data-v-074d9f77>Error Response</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-074d9f77 data-v-074d9f77><div class="item" data-v-074d9f77><div class="indicator" data-v-074d9f77></div><a class="VPLink link link" href="/en/api/#status-codes" data-v-074d9f77><!--[--><p class="text" data-v-074d9f77>Status Codes</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-b6c923d7 data-v-62f80edf><div class="VPDoc has-sidebar has-aside" data-v-62f80edf data-v-c7e25d19><!--[--><!--]--><div class="container" data-v-c7e25d19><div class="aside" data-v-c7e25d19><div class="aside-curtain" data-v-c7e25d19></div><div class="aside-container" data-v-c7e25d19><div class="aside-content" data-v-c7e25d19><div class="VPDocAside" data-v-c7e25d19 data-v-a7c337e5><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-a7c337e5 data-v-30bc7595><div class="content" data-v-30bc7595><div class="outline-marker" data-v-30bc7595></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-30bc7595>目录</div><ul class="VPDocOutlineItem root" data-v-30bc7595 data-v-697bcd1c><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-a7c337e5></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-c7e25d19><div class="content-container" data-v-c7e25d19><!--[--><!--]--><main class="main" data-v-c7e25d19><div style="position:relative;" class="vp-doc _en_api_" data-v-c7e25d19><div><h1 id="filecodebox-api-documentation" tabindex="-1">FileCodeBox API Documentation <a class="header-anchor" href="#filecodebox-api-documentation" aria-label="Permalink to &quot;FileCodeBox API Documentation&quot;">​</a></h1><h2 id="api-version-2-1-0" tabindex="-1">API Version: 2.1.0 <a class="header-anchor" href="#api-version-2-1-0" aria-label="Permalink to &quot;API Version: 2.1.0&quot;">​</a></h2><h2 id="table-of-contents" tabindex="-1">Table of Contents <a class="header-anchor" href="#table-of-contents" aria-label="Permalink to &quot;Table of Contents&quot;">​</a></h2><ul><li><a href="#authentication">Authentication</a></li><li><a href="#share-api">Share API</a></li><li><a href="#admin-api">Admin API</a></li></ul><h2 id="authentication" tabindex="-1">Authentication <a class="header-anchor" href="#authentication" aria-label="Permalink to &quot;Authentication&quot;">​</a></h2><p>Some APIs require <code>Authorization</code> header for authentication:</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>Authorization: Bearer &lt;token&gt;</span></span></code></pre></div><h2 id="share-api" tabindex="-1">Share API <a class="header-anchor" href="#share-api" aria-label="Permalink to &quot;Share API&quot;">​</a></h2><h3 id="share-text" tabindex="-1">Share Text <a class="header-anchor" href="#share-text" aria-label="Permalink to &quot;Share Text&quot;">​</a></h3><p><strong>POST</strong> <code>/share/text/</code></p><p>Share text content and get a share code.</p><p><strong>Parameters:</strong></p><table tabindex="0"><thead><tr><th>Parameter</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>text</td><td>string</td><td>Yes</td><td>-</td><td>Text content to share</td></tr><tr><td>expire_value</td><td>integer</td><td>No</td><td>1</td><td>Expiration time value</td></tr><tr><td>expire_style</td><td>string</td><td>No</td><td>&quot;day&quot;</td><td>Expiration time unit(day/hour/minute)</td></tr></tbody></table><p><strong>Response Example:</strong></p><div class="language-json vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;code&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">200</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;msg&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;success&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;detail&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: {</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;code&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;abc123&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;name&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;text.txt&quot;</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> }</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><h3 id="share-file" tabindex="-1">Share File <a class="header-anchor" href="#share-file" aria-label="Permalink to &quot;Share File&quot;">​</a></h3><p><strong>POST</strong> <code>/share/file/</code></p><p>Upload and share a file, get a share code.</p><p><strong>Parameters:</strong></p><table tabindex="0"><thead><tr><th>Parameter</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>file</td><td>file</td><td>Yes</td><td>-</td><td>File to upload</td></tr><tr><td>expire_value</td><td>integer</td><td>No</td><td>1</td><td>Expiration time value</td></tr><tr><td>expire_style</td><td>string</td><td>No</td><td>&quot;day&quot;</td><td>Expiration time unit(day/hour/minute)</td></tr></tbody></table><p><strong>Response Example:</strong></p><div class="language-json vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;code&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">200</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;msg&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;success&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;detail&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: {</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;code&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;abc123&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;name&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;example.txt&quot;</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> }</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><h3 id="get-file-info" tabindex="-1">Get File Info <a class="header-anchor" href="#get-file-info" aria-label="Permalink to &quot;Get File Info&quot;">​</a></h3><p><strong>GET</strong> <code>/share/select/</code></p><p>Get file information by share code.</p><p><strong>Parameters:</strong></p><table tabindex="0"><thead><tr><th>Parameter</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td>code</td><td>string</td><td>Yes</td><td>File share code</td></tr></tbody></table><p><strong>Response Example:</strong></p><div class="language-json vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;code&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">200</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;msg&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;success&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;detail&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: {</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;code&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;abc123&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;name&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;example.txt&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;size&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">1024</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;text&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;File content or download link&quot;</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> }</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><h3 id="select-file" tabindex="-1">Select File <a class="header-anchor" href="#select-file" aria-label="Permalink to &quot;Select File&quot;">​</a></h3><p><strong>POST</strong> <code>/share/select/</code></p><p>Select file by share code.</p><p><strong>Parameters:</strong></p><table tabindex="0"><thead><tr><th>Parameter</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td>code</td><td>string</td><td>Yes</td><td>File share code</td></tr></tbody></table><p><strong>Response Example:</strong></p><div class="language-json vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;code&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">200</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;msg&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;success&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;detail&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: {</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;code&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;abc123&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;name&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;example.txt&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;size&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">1024</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;text&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;File content or download link&quot;</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> }</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><h3 id="download-file" tabindex="-1">Download File <a class="header-anchor" href="#download-file" aria-label="Permalink to &quot;Download File&quot;">​</a></h3><p><strong>GET</strong> <code>/share/download</code></p><p>Download shared file.</p><p><strong>Parameters:</strong></p><table tabindex="0"><thead><tr><th>Parameter</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td>key</td><td>string</td><td>Yes</td><td>Download key</td></tr><tr><td>code</td><td>string</td><td>Yes</td><td>File share code</td></tr></tbody></table><h2 id="admin-api" tabindex="-1">Admin API <a class="header-anchor" href="#admin-api" aria-label="Permalink to &quot;Admin API&quot;">​</a></h2><h3 id="admin-login" tabindex="-1">Admin Login <a class="header-anchor" href="#admin-login" aria-label="Permalink to &quot;Admin Login&quot;">​</a></h3><p><strong>POST</strong> <code>/admin/login</code></p><p>Admin login to get token.</p><p><strong>Parameters:</strong></p><table tabindex="0"><thead><tr><th>Parameter</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td>password</td><td>string</td><td>Yes</td><td>Admin password</td></tr></tbody></table><h3 id="dashboard-data" tabindex="-1">Dashboard Data <a class="header-anchor" href="#dashboard-data" aria-label="Permalink to &quot;Dashboard Data&quot;">​</a></h3><p><strong>GET</strong> <code>/admin/dashboard</code></p><p>Get system dashboard data.</p><p><strong>Response Example:</strong></p><div class="language-json vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;code&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">200</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;msg&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;success&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;detail&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: {</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;totalFiles&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">100</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;storageUsed&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;1.5GB&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;sysUptime&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;10 days&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;yesterdayCount&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">50</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;yesterdaySize&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;500MB&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;todayCount&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">30</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;todaySize&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;300MB&quot;</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> }</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><h3 id="file-list" tabindex="-1">File List <a class="header-anchor" href="#file-list" aria-label="Permalink to &quot;File List&quot;">​</a></h3><p><strong>GET</strong> <code>/admin/file/list</code></p><p>Get system file list.</p><p><strong>Parameters:</strong></p><table tabindex="0"><thead><tr><th>Parameter</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>page</td><td>integer</td><td>No</td><td>1</td><td>Current page</td></tr><tr><td>size</td><td>integer</td><td>No</td><td>10</td><td>Page size</td></tr><tr><td>keyword</td><td>string</td><td>No</td><td>&quot;&quot;</td><td>Search keyword</td></tr></tbody></table><p><strong>Response Example:</strong></p><div class="language-json vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;code&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">200</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;msg&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;success&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;detail&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: {</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;page&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">1</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;size&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">10</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;total&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">100</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;data&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: [</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;id&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">1</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;name&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;example.txt&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;size&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">1024</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;created_at&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;2024-01-01 12:00:00&quot;</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> }</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> ]</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> }</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><h3 id="delete-file" tabindex="-1">Delete File <a class="header-anchor" href="#delete-file" aria-label="Permalink to &quot;Delete File&quot;">​</a></h3><p><strong>DELETE</strong> <code>/admin/file/delete</code></p><p>Delete file from system.</p><p><strong>Parameters:</strong></p><table tabindex="0"><thead><tr><th>Parameter</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td>id</td><td>integer</td><td>Yes</td><td>File ID</td></tr></tbody></table><h3 id="get-config" tabindex="-1">Get Config <a class="header-anchor" href="#get-config" aria-label="Permalink to &quot;Get Config&quot;">​</a></h3><p><strong>GET</strong> <code>/admin/config/get</code></p><p>Get system configuration.</p><h3 id="update-config" tabindex="-1">Update Config <a class="header-anchor" href="#update-config" aria-label="Permalink to &quot;Update Config&quot;">​</a></h3><p><strong>PATCH</strong> <code>/admin/config/update</code></p><p>Update system configuration.</p><h2 id="error-response" tabindex="-1">Error Response <a class="header-anchor" href="#error-response" aria-label="Permalink to &quot;Error Response&quot;">​</a></h2><p>When an error occurs, the API will return corresponding error message:</p><div class="language-json vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;code&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">422</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;detail&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: [</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;loc&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: [</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;body&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;password&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">],</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;msg&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;Password cannot be empty&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> &quot;type&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;value_error&quot;</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> }</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> ]</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><h2 id="status-codes" tabindex="-1">Status Codes <a class="header-anchor" href="#status-codes" aria-label="Permalink to &quot;Status Codes&quot;">​</a></h2><ul><li>200: Success</li><li>401: Unauthorized</li><li>403: Forbidden</li><li>404: Not Found</li><li>422: Validation Error</li><li>500: Internal Server Error</li></ul></div></div></main><footer class="VPDocFooter" data-v-c7e25d19 data-v-2dcb78e4><!--[--><!--]--><div class="edit-info" data-v-2dcb78e4><!----><div class="last-updated" data-v-2dcb78e4><p class="VPLastUpdated" data-v-2dcb78e4 data-v-afb38d82>Last updated: <time datetime="2025-02-12T03:29:22.000Z" data-v-afb38d82></time></p></div></div><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-2dcb78e4><span class="visually-hidden" id="doc-footer-aria-label" data-v-2dcb78e4>Pager</span><div class="pager" data-v-2dcb78e4><!----></div><div class="pager" data-v-2dcb78e4><a class="VPLink link pager-link next" href="/en/api/#share-api" data-v-2dcb78e4><!--[--><span class="desc" data-v-2dcb78e4>Next page</span><span class="title" data-v-2dcb78e4>Share API</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-b6c923d7 data-v-22dc8f31><div class="container" data-v-22dc8f31><p class="message" data-v-22dc8f31>基于 MIT 许可发布</p><p class="copyright" data-v-22dc8f31>Copyright © 2023-present FileCodeBox</p></div></footer><!--[--><!--]--></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"api_index.md\":\"qG09VB3V\",\"changelog.md\":\"C8aI6QEN\",\"contributing.md\":\"k9HB5RBU\",\"en_api_index.md\":\"DowD_P4F\",\"en_changelog.md\":\"BcADjzAG\",\"en_contributing.md\":\"PVT9OVBi\",\"en_guide_configuration.md\":\"B0l-oJMx\",\"en_guide_getting-started.md\":\"Dn8s1IIJ\",\"en_guide_introduction.md\":\"BD40RLpr\",\"en_guide_management.md\":\"B7zTh6Wx\",\"en_guide_security.md\":\"Cviop6qN\",\"en_guide_share.md\":\"76VwCXWs\",\"en_guide_storage.md\":\"BYAxNGDy\",\"en_guide_upload copy.md\":\"DjRt4QqF\",\"en_guide_upload.md\":\"DUnZK1hP\",\"en_index.md\":\"tZNBw7JM\",\"guide_configuration.md\":\"BIXg2nLZ\",\"guide_getting-started.md\":\"BG1qGt6J\",\"guide_introduction.md\":\"CebWHzyk\",\"guide_management.md\":\"eUCTNsEJ\",\"guide_security.md\":\"-P7VdlH3\",\"guide_share.md\":\"CQJMq2_v\",\"guide_storage.md\":\"OPzq4lQ1\",\"guide_upload.md\":\"BGoSj7Ei\",\"index.md\":\"BrsJo2Pg\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"zh-CN\",\"dir\":\"ltr\",\"title\":\"FileCodeBox\",\"description\":\"简单高效的文件分享工具\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"langMenuLabel\":\"切换语言\",\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/vastsa/FileCodeBox\"}],\"footer\":{\"message\":\"基于 MIT 许可发布\",\"copyright\":\"Copyright © 2023-present FileCodeBox\"},\"search\":{\"provider\":\"local\",\"options\":{\"locales\":{\"zh\":{\"translations\":{\"button\":{\"buttonText\":\"搜索文档\",\"buttonAriaLabel\":\"搜索文档\"},\"modal\":{\"noResultsText\":\"无法找到相关结果\",\"resetButtonTitle\":\"清除查询条件\",\"footer\":{\"selectText\":\"选择\",\"navigateText\":\"切换\"}}}}}}},\"outline\":{\"level\":[2,3],\"label\":\"目录\"}},\"locales\":{\"root\":{\"label\":\"简体中文\",\"lang\":\"zh-CN\",\"title\":\"FileCodeBox\",\"description\":\"匿名口令分享文本，文件\",\"themeConfig\":{\"logo\":\"/logo_small.png\",\"nav\":[{\"text\":\"首页\",\"link\":\"/\"},{\"text\":\"指南\",\"link\":\"/guide/getting-started\"},{\"text\":\"API\",\"link\":\"/api/\"},{\"text\":\"了解更多\",\"items\":[{\"text\":\"更新日志\",\"link\":\"/changelog\"},{\"text\":\"贡献指南\",\"link\":\"/contributing\"}]}],\"sidebar\":{\"/guide/\":[{\"text\":\"介绍\",\"items\":[{\"text\":\"什么是 FileCodeBox\",\"link\":\"/guide/introduction\"},{\"text\":\"快速开始\",\"link\":\"/guide/getting-started\"}]},{\"text\":\"基础功能\",\"items\":[{\"text\":\"文件上传\",\"link\":\"/guide/upload\"},{\"text\":\"文件分享\",\"link\":\"/guide/share\"},{\"text\":\"文件管理\",\"link\":\"/guide/management\"}]},{\"text\":\"高级特性\",\"items\":[{\"text\":\"存储配置\",\"link\":\"/guide/storage\"},{\"text\":\"安全设置\",\"link\":\"/guide/security\"},{\"text\":\"系统配置\",\"link\":\"/guide/configuration\"}]}],\"/api/\":[{\"text\":\"API 参考\",\"items\":[{\"text\":\"分享接口\",\"link\":\"/api/#分享接口\"},{\"text\":\"管理接口\",\"link\":\"/api/#管理接口\"},{\"text\":\"错误响应\",\"link\":\"/api/#错误响应\"},{\"text\":\"状态码说明\",\"link\":\"/api/#状态码说明\"}]}]},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/vastsa/FileCodeBox\"}],\"footer\":{\"message\":\"基于 LGPL 许可发布\",\"copyright\":\"Copyright © 2023-present FileCodeBox\"},\"search\":{\"provider\":\"local\"},\"outline\":{\"level\":[2,3],\"label\":\"目录\"}}},\"en\":{\"label\":\"English\",\"lang\":\"en-US\",\"title\":\"FileCodeBox\",\"description\":\"Simple and efficient file sharing tool\",\"themeConfig\":{\"logo\":\"/logo_small.png\",\"nav\":[{\"text\":\"Home\",\"link\":\"/en/\"},{\"text\":\"Guide\",\"link\":\"/en/guide/getting-started\"},{\"text\":\"API\",\"link\":\"/en/api/\"},{\"text\":\"More\",\"items\":[{\"text\":\"Changelog\",\"link\":\"/en/changelog\"},{\"text\":\"Contributing\",\"link\":\"/en/contributing\"}]}],\"sidebar\":{\"/en/guide/\":[{\"text\":\"Introduction\",\"items\":[{\"text\":\"What is FileCodeBox\",\"link\":\"/en/guide/introduction\"},{\"text\":\"Getting Started\",\"link\":\"/en/guide/getting-started\"}]},{\"text\":\"Basic Features\",\"items\":[{\"text\":\"File Upload\",\"link\":\"/en/guide/upload\"},{\"text\":\"File Sharing\",\"link\":\"/en/guide/share\"},{\"text\":\"File Management\",\"link\":\"/en/guide/management\"}]},{\"text\":\"Advanced Features\",\"items\":[{\"text\":\"Storage Configuration\",\"link\":\"/en/guide/storage\"},{\"text\":\"Security Settings\",\"link\":\"/en/guide/security\"},{\"text\":\"System Configuration\",\"link\":\"/en/guide/configuration\"}]}],\"/en/api/\":[{\"text\":\"API Reference\",\"items\":[{\"text\":\"Share API\",\"link\":\"/en/api/#share-api\"},{\"text\":\"Admin API\",\"link\":\"/en/api/#admin-api\"},{\"text\":\"Error Response\",\"link\":\"/en/api/#error-response\"},{\"text\":\"Status Codes\",\"link\":\"/en/api/#status-codes\"}]}]},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/vastsa/FileCodeBox\"}],\"footer\":{\"message\":\"基于 MIT 许可发布\",\"copyright\":\"Copyright © 2023-present FileCodeBox\"},\"search\":{\"provider\":\"local\"},\"outline\":{\"level\":[2,3],\"label\":\"目录\"}}}},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink