mirror of
https://github.com/XiaoDaiGua-Ray/ray-template.git
synced 2026-11-18 08:53:34 +08:00
51 lines
33 KiB
HTML
51 lines
33 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="zh-CN" dir="ltr">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
<title>接口、取消与 Mock · Ray Template 文档</title>
|
||
<meta name="description" content="Ray Template 6.0.0 的 Monorepo 架构、版本分界、组件与交互示例。">
|
||
<meta name="generator" content="VitePress v1.6.4">
|
||
<link rel="preload stylesheet" href="/ray-template/docs/assets/style.x9OR2Sj_.css" as="style">
|
||
<link rel="preload stylesheet" href="/ray-template/docs/vp-icons.css" as="style">
|
||
|
||
<script type="module" src="/ray-template/docs/assets/app.UdRXoQ1Z.js"></script>
|
||
<link rel="preload" href="/ray-template/docs/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
|
||
<link rel="modulepreload" href="/ray-template/docs/assets/chunks/theme.C9yy6i4V.js">
|
||
<link rel="modulepreload" href="/ray-template/docs/assets/chunks/framework.BNdm2jZV.js">
|
||
<link rel="modulepreload" href="/ray-template/docs/assets/guide_requests.md.DXAGH_Ni.lean.js">
|
||
<link rel="icon" type="image/svg+xml" href="/ray-template/docs/ray-mark.svg">
|
||
<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-f9c03b6e><!--[--><!--]--><!--[--><span tabindex="-1" data-v-770676c7></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-770676c7>跳转到正文</a><!--]--><!----><header class="VPNav" data-v-f9c03b6e data-v-b2a7789c><div class="VPNavBar" data-v-b2a7789c data-v-d231c45b><div class="wrapper" data-v-d231c45b><div class="container" data-v-d231c45b><div class="title" data-v-d231c45b><div class="VPNavBarTitle has-sidebar" data-v-d231c45b data-v-49754884><a class="title" href="/ray-template/docs/" data-v-49754884><!--[--><!--]--><!--[--><img class="VPImage logo" src="/ray-template/docs/ray-mark.svg" alt data-v-a9cdc337><!--]--><span data-v-49754884>Ray Template</span><!--[--><!--]--></a></div></div><div class="content" data-v-d231c45b><div class="content-body" data-v-d231c45b><!--[--><!--]--><div class="VPNavBarSearch search" data-v-d231c45b><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="搜索文档"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">搜索文档</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-d231c45b data-v-49bcf2ef><span id="main-nav-aria-label" class="visually-hidden" data-v-49bcf2ef> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink active" href="/ray-template/docs/guide/start.html" tabindex="0" data-v-49bcf2ef data-v-991603b8><!--[--><span data-v-991603b8>指南</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/ray-template/docs/guide/architecture.html" tabindex="0" data-v-49bcf2ef data-v-991603b8><!--[--><span data-v-991603b8>架构</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/ray-template/docs/migration.html" tabindex="0" data-v-49bcf2ef data-v-991603b8><!--[--><span data-v-991603b8>版本分界</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/ray-template/docs/reference/" tabindex="0" data-v-49bcf2ef data-v-991603b8><!--[--><span data-v-991603b8>API 参考</span><!--]--></a><!--]--><!--[--><a class="VPLink link vp-external-link-icon VPNavBarMenuLink" href="https://xiaodaigua-ray.github.io/ray-template/" target="_blank" rel="noreferrer" tabindex="0" data-v-49bcf2ef data-v-991603b8><!--[--><span data-v-991603b8>Ray Admin</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-d231c45b data-v-a4a103b4><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-a4a103b4 data-v-2b76c23f data-v-54e91c08><span class="check" data-v-54e91c08><span class="icon" data-v-54e91c08><!--[--><span class="vpi-sun sun" data-v-2b76c23f></span><span class="vpi-moon moon" data-v-2b76c23f></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-d231c45b data-v-584f2254 data-v-91f5f172><!--[--><a class="VPSocialLink no-icon" href="https://github.com/XiaoDaiGua-Ray/ray-template" aria-label="github" target="_blank" rel="noopener" data-v-91f5f172 data-v-976d6037><span class="vpi-social-github"></span></a><!--]--></div><div class="VPFlyout VPNavBarExtra extra" data-v-d231c45b data-v-766dd493 data-v-57202eaf><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-57202eaf><span class="vpi-more-horizontal icon" data-v-57202eaf></span></button><div class="menu" data-v-57202eaf><div class="VPMenu" data-v-57202eaf data-v-80746065><!----><!--[--><!--[--><!----><div class="group" data-v-766dd493><div class="item appearance" data-v-766dd493><p class="label" data-v-766dd493>主题</p><div class="appearance-action" data-v-766dd493><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-766dd493 data-v-2b76c23f data-v-54e91c08><span class="check" data-v-54e91c08><span class="icon" data-v-54e91c08><!--[--><span class="vpi-sun sun" data-v-2b76c23f></span><span class="vpi-moon moon" data-v-2b76c23f></span><!--]--></span></span></button></div></div></div><div class="group" data-v-766dd493><div class="item social-links" data-v-766dd493><div class="VPSocialLinks social-links-list" data-v-766dd493 data-v-91f5f172><!--[--><a class="VPSocialLink no-icon" href="https://github.com/XiaoDaiGua-Ray/ray-template" aria-label="github" target="_blank" rel="noopener" data-v-91f5f172 data-v-976d6037><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-d231c45b data-v-0ee194e1><span class="container" data-v-0ee194e1><span class="top" data-v-0ee194e1></span><span class="middle" data-v-0ee194e1></span><span class="bottom" data-v-0ee194e1></span></span></button></div></div></div></div><div class="divider" data-v-d231c45b><div class="divider-line" data-v-d231c45b></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-f9c03b6e data-v-60478e07><div class="container" data-v-60478e07><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-60478e07><span class="vpi-align-left menu-icon" data-v-60478e07></span><span class="menu-text" data-v-60478e07>文档目录</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-60478e07 data-v-debc629b><button data-v-debc629b>回到顶部</button><!----></div></div></div><aside class="VPSidebar" data-v-f9c03b6e data-v-efe03c19><div class="curtain" data-v-efe03c19></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-efe03c19><span class="visually-hidden" id="sidebar-aria-label" data-v-efe03c19> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-90a0702d><section class="VPSidebarItem level-0" data-v-90a0702d data-v-d34e54b2><div class="item" role="button" tabindex="0" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><h2 class="text" data-v-d34e54b2>入门</h2><!----></div><div class="items" data-v-d34e54b2><!--[--><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/guide/start.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>快速开始</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/guide/architecture.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>v6 Monorepo 架构</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/migration.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>v5 与 v6 的版本分界</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/guide/first-page.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>第一个业务页面</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-90a0702d><section class="VPSidebarItem level-0 has-active" data-v-90a0702d data-v-d34e54b2><div class="item" role="button" tabindex="0" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><h2 class="text" data-v-d34e54b2>开发指南</h2><!----></div><div class="items" data-v-d34e54b2><!--[--><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/guide/routing.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>路由、菜单与权限</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/guide/layout.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>应用布局与状态</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/guide/requests.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>接口、取消与 Mock</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/guide/appearance.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>主题与国际化</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/guide/tooling.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>工程检查与部署</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-90a0702d><section class="VPSidebarItem level-0" data-v-90a0702d data-v-d34e54b2><!----><div class="items" data-v-d34e54b2><!--[--><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>API 参考</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-f9c03b6e data-v-7ec33352><div class="VPDoc has-sidebar has-aside" data-v-7ec33352 data-v-b0483432><!--[--><!--]--><div class="container" data-v-b0483432><div class="aside" data-v-b0483432><div class="aside-curtain" data-v-b0483432></div><div class="aside-container" data-v-b0483432><div class="aside-content" data-v-b0483432><div class="VPDocAside" data-v-b0483432 data-v-6d31e1a2><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-6d31e1a2 data-v-a849a091><div class="content" data-v-a849a091><div class="outline-marker" data-v-a849a091></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-a849a091>本页目录</div><ul class="VPDocOutlineItem root" data-v-a849a091 data-v-78a615b5><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-6d31e1a2></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-b0483432><div class="content-container" data-v-b0483432><!--[--><!--[--><!--[--><div class="ray-doc-meta"><span>开发指南</span><a href="/ray-template/docs/reference/source.html">版本 <code>6.0.0</code></a></div><!--]--><!--]--><!--]--><main class="main" data-v-b0483432><div style="position:relative;" class="vp-doc _ray-template_docs_guide_requests" data-v-b0483432><div><h1 id="接口、取消与-mock" tabindex="-1">接口、取消与 Mock <a class="header-anchor" href="#接口、取消与-mock" aria-label="Permalink to "接口、取消与 Mock""></a></h1><p>业务代码调用 <code>apps/admin/src/api</code> 中的函数,后者使用 <code>@/axios</code> 的 <code>request</code>。成功时实例直接解析为响应体 <code>T</code>,失败会拒绝;接口还包了一层业务响应时,由业务层继续解析。需要原始响应头或状态码时,使用保留完整响应的 Axios 实例。</p><h2 id="接入请求和取消" tabindex="-1">接入请求和取消 <a class="header-anchor" href="#接入请求和取消" aria-label="Permalink to "接入请求和取消""></a></h2><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { request } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> '@/axios'</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">interface</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> Order</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
|
||
<span class="line"><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> id</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">:</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> string</span></span>
|
||
<span class="line"><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> customer</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">:</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> string</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> function</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> loadOrders</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span></span>
|
||
<span class="line"><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> params</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">:</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> Record</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"><</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">string</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">unknown</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">>,</span></span>
|
||
<span class="line"><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> signal</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">:</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> AbortSignal</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:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> request</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"><{ </span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">data</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">:</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> Order</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">[]; </span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">total</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">:</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> number</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> }>({</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> method: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'get'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> url: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'/api/orders'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> params,</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> signal,</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> cancelConfig: { cancel: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">false</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:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><p>默认取消器按 URL、方法、参数和请求体识别重复请求,默认布局在路由更新前取消受管理的请求。示例将信号交给 TablePro 管理,所以关闭模板的默认注入;否则默认取消器会替换调用方传入的 signal。后台任务禁用默认取消后,需要自行管理生命周期。</p><h2 id="配置与拦截器" tabindex="-1">配置与拦截器 <a class="header-anchor" href="#配置与拦截器" aria-label="Permalink to "配置与拦截器""></a></h2><ul><li><code>apps/admin/src/app-config/request-config.ts</code>:统一修改 <code>baseURL</code>、超时和默认 headers。</li><li><code>apps/admin/src/axios/axios-interceptor/{request,response}/provider.ts</code>:登记插件;请求头、鉴权响应等放入对应的 <code>plugins</code>。</li><li><code>useRequest</code> 包装同一请求实例,放在有效的 Vue effect 作用域内使用。</li></ul><h2 id="从演示切到真实服务" tabindex="-1">从演示切到真实服务 <a class="header-anchor" href="#从演示切到真实服务" aria-label="Permalink to "从演示切到真实服务""></a></h2><p>开发时人员列表请求 <code>GET /api/list</code>,Vite Mock 服务在站点根路径处理接口。静态演示改用 <code>apps/admin/src/demo-data/people.ts</code> 的本地数据,能在 GitHub Pages 上独立运行。业务项目应换成自己的 API 和会话,按环境配置开发代理或服务端反代;浏览器端 <code>VITE_*</code> 变量不能放密钥。</p><p><a href="https://github.com/XiaoDaiGua-Ray/ray-template/blob/403fdd589abbe37b38e1240d34f8daf2a60d3690/apps/admin/src/axios/instance.ts" target="_blank" rel="noreferrer">请求实例</a> · <a href="https://github.com/XiaoDaiGua-Ray/ray-template/blob/403fdd589abbe37b38e1240d34f8daf2a60d3690/apps/admin/src/api/demo/mock/person.ts" target="_blank" rel="noreferrer">演示接口</a></p><h2 id="userequest-与手动执行" tabindex="-1">useRequest 与手动执行 <a class="header-anchor" href="#userequest-与手动执行" aria-label="Permalink to "useRequest 与手动执行""></a></h2><p><code>useRequest<Response>(fetchOptions, options?)</code> 从 <code>@/axios</code> 导入,使用模板 Axios 实例执行同一份配置。<code>options</code> 传给 vue-hooks-plus,例如 <code>manual</code>、成功和失败回调。返回的数据、错误、加载状态与运行方法来自上游 Hook。应用在 <code>setup</code> 或有效 effect scope 内创建它。</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { useRequest } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> '@/axios'</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> function</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> useOrderSummary</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">() {</span></span>
|
||
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> useRequest</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"><{ </span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">total</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">:</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> number</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> }>(</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { url: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'/api/orders/summary'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, method: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'get'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> },</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { manual: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">true</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:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><p>调用 <code>run()</code> 触发手动加载。这个包装的请求函数从 <code>fetchOptions</code> 读取配置,不会把 <code>run(...)</code> 参数自动映射成请求体或 query;需要动态 service 时用同入口导出的 <code>useHookPlusRequest(service, options?)</code>,在 service 中调用 <code>request</code>。错误提示由业务配置或响应拦截器负责,当前默认拦截器不消费 <code>responseSuccessMessage</code> / <code>responseErrorMessage</code> 两个类型字段。</p><p>默认头注入包含演示 <code>X-TOKEN</code> 与示例头。对接真实接口时在请求插件中校验目标来源,并按后端约定设置认证头。模板 Axios 实例用来请求自己的业务接口;第三方地址使用明确配置的独立客户端。</p><p><a href="https://github.com/XiaoDaiGua-Ray/ray-template/blob/403fdd589abbe37b38e1240d34f8daf2a60d3690/apps/admin/src/axios/index.ts" target="_blank" rel="noreferrer">请求 Hook</a> · <a href="https://github.com/XiaoDaiGua-Ray/ray-template/blob/403fdd589abbe37b38e1240d34f8daf2a60d3690/packages/http/src/types.ts" target="_blank" rel="noreferrer">请求配置类型</a> · <a href="https://github.com/XiaoDaiGua-Ray/ray-template/blob/403fdd589abbe37b38e1240d34f8daf2a60d3690/apps/admin/src/axios/axios-interceptor/request/plugins/request-headers.ts" target="_blank" rel="noreferrer">头注入实现</a></p></div></div></main><footer class="VPDocFooter" data-v-b0483432 data-v-028296d9><!--[--><!--]--><!----><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-028296d9><span class="visually-hidden" id="doc-footer-aria-label" data-v-028296d9>Pager</span><div class="pager" data-v-028296d9><a class="VPLink link pager-link prev" href="/ray-template/docs/guide/layout.html" data-v-028296d9><!--[--><span class="desc" data-v-028296d9>上一页</span><span class="title" data-v-028296d9>应用布局与状态</span><!--]--></a></div><div class="pager" data-v-028296d9><a class="VPLink link pager-link next" href="/ray-template/docs/guide/appearance.html" data-v-028296d9><!--[--><span class="desc" data-v-028296d9>下一页</span><span class="title" data-v-028296d9>主题与国际化</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-f9c03b6e data-v-20a32aa3><div class="container" data-v-20a32aa3><!----><p class="copyright" data-v-20a32aa3>© 2022–至今 Ray · MIT License</p></div></footer><!--[--><!--]--></div></div>
|
||
<script>window.__VP_HASH_MAP__=JSON.parse("{\"guide_appearance.md\":\"D-523bFh\",\"guide_architecture.md\":\"C6HIHYR1\",\"guide_first-page.md\":\"z-hytCrx\",\"guide_layout.md\":\"B7nfsGPS\",\"guide_requests.md\":\"DXAGH_Ni\",\"guide_routing.md\":\"CyhQoTmx\",\"guide_start.md\":\"B6oCR027\",\"guide_tooling.md\":\"CkJoP04H\",\"index.md\":\"nUYT09g4\",\"migration.md\":\"CIZms3hv\",\"playground_shell.md\":\"CH48frZN\",\"reference_components.md\":\"iMZjSjdU\",\"reference_components_app.md\":\"Q6aQiDRo\",\"reference_components_barcode.md\":\"BbJVFbEo\",\"reference_components_chart.md\":\"JthpvMcl\",\"reference_components_collapse-grid.md\":\"_8SHiB6D\",\"reference_components_draggable-card.md\":\"4XemeqwB\",\"reference_components_flow.md\":\"s-rnj-8X\",\"reference_components_form.md\":\"BrB2cmbN\",\"reference_components_iframe.md\":\"CZP63QsN\",\"reference_components_modal.md\":\"bQ_aJsj-\",\"reference_components_more-dropdown.md\":\"BubiDbuv\",\"reference_components_qr-code.md\":\"BtXSFJtd\",\"reference_components_route-transition.md\":\"Dg7dX5PR\",\"reference_components_segment.md\":\"BrQOf2XY\",\"reference_configuration.md\":\"BeYwV4AY\",\"reference_directives.md\":\"DZcDGixq\",\"reference_hooks.md\":\"fkz_ntnz\",\"reference_hooks_appearance.md\":\"JMrRj834\",\"reference_hooks_browser.md\":\"D5n_xtb0\",\"reference_hooks_interaction.md\":\"Big820ZZ\",\"reference_hooks_layout.md\":\"BcnUJtrr\",\"reference_hooks_navigation.md\":\"CGGlTsKj\",\"reference_hooks_output.md\":\"B8QXZTOo\",\"reference_icons.md\":\"lwCUuJHp\",\"reference_index.md\":\"DRoeAVBG\",\"reference_source.md\":\"M6GWIIfO\",\"reference_store.md\":\"BykMC8BP\",\"reference_store_navigation.md\":\"BBSrn9C3\",\"reference_store_runtime.md\":\"DN1nqjBy\",\"reference_store_setting.md\":\"CB2Icw7k\",\"reference_store_signing.md\":\"453f7xx-\",\"reference_table-pro.md\":\"DW6Gztpq\",\"reference_utils.md\":\"CPo2FGYU\",\"reference_utils_browser.md\":\"mqqbsAE7\",\"reference_utils_core.md\":\"D6K4f3-H\",\"reference_utils_storage.md\":\"aIMEPocl\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"zh-CN\",\"dir\":\"ltr\",\"title\":\"Ray Template\",\"titleTemplate\":\":title · Ray Template 文档\",\"description\":\"Ray Template 6.0.0 的 Monorepo 架构、版本分界、组件与交互示例。\",\"base\":\"/ray-template/docs/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":{\"src\":\"/ray-mark.svg\",\"alt\":\"\"},\"siteTitle\":\"Ray Template\",\"nav\":[{\"text\":\"指南\",\"link\":\"/guide/start\",\"activeMatch\":\"^/guide/\"},{\"text\":\"架构\",\"link\":\"/guide/architecture\"},{\"text\":\"版本分界\",\"link\":\"/migration\"},{\"text\":\"API 参考\",\"link\":\"/reference/\",\"activeMatch\":\"^/reference/\"},{\"text\":\"Ray Admin\",\"link\":\"https://xiaodaigua-ray.github.io/ray-template/\"}],\"sidebar\":{\"/reference/\":[{\"text\":\"API 参考总览\",\"link\":\"/reference/\"},{\"text\":\"组件\",\"link\":\"/reference/components\",\"collapsed\":true,\"items\":[{\"text\":\"TablePro\",\"link\":\"/reference/table-pro\"},{\"text\":\"RForm 与 useForm\",\"link\":\"/reference/components/form\"},{\"text\":\"RModal\",\"link\":\"/reference/components/modal\"},{\"text\":\"RChart 与 useChart\",\"link\":\"/reference/components/chart\"},{\"text\":\"RFlow 与 useFlow\",\"link\":\"/reference/components/flow\"},{\"text\":\"RCollapseGrid\",\"link\":\"/reference/components/collapse-grid\"},{\"text\":\"RSegment\",\"link\":\"/reference/components/segment\"},{\"text\":\"RMoreDropdown\",\"link\":\"/reference/components/more-dropdown\"},{\"text\":\"RIframe\",\"link\":\"/reference/components/iframe\"},{\"text\":\"RBarcode\",\"link\":\"/reference/components/barcode\"},{\"text\":\"RDraggableCard\",\"link\":\"/reference/components/draggable-card\"},{\"text\":\"RTransitionComponent\",\"link\":\"/reference/components/route-transition\"},{\"text\":\"RIcon 与 SVG 图标\",\"link\":\"/reference/icons\"},{\"text\":\"二维码\",\"link\":\"/reference/components/qr-code\"},{\"text\":\"应用组件与 Provider\",\"link\":\"/reference/components/app\"}]},{\"text\":\"Hooks\",\"link\":\"/reference/hooks\",\"collapsed\":true,\"items\":[{\"text\":\"导航与菜单\",\"link\":\"/reference/hooks/navigation\"},{\"text\":\"布局与滚动\",\"link\":\"/reference/hooks/layout\"},{\"text\":\"主题、语言和水印\",\"link\":\"/reference/hooks/appearance\"},{\"text\":\"分页与右键菜单\",\"link\":\"/reference/hooks/interaction\"},{\"text\":\"窗口、全屏和日期\",\"link\":\"/reference/hooks/browser\"},{\"text\":\"DOM 截图与打印\",\"link\":\"/reference/hooks/output\"}]},{\"text\":\"指令\",\"link\":\"/reference/directives\"},{\"text\":\"Store\",\"link\":\"/reference/store\",\"collapsed\":true,\"items\":[{\"text\":\"Setting\",\"link\":\"/reference/store/setting\"},{\"text\":\"Menu 与 KeepAlive\",\"link\":\"/reference/store/navigation\"},{\"text\":\"Runtime 与 Lock Screen\",\"link\":\"/reference/store/runtime\"},{\"text\":\"Signing\",\"link\":\"/reference/store/signing\"}]},{\"text\":\"工具函数\",\"link\":\"/reference/utils\",\"collapsed\":true,\"items\":[{\"text\":\"基础、日期和数值\",\"link\":\"/reference/utils/core\"},{\"text\":\"缓存与兼容加密\",\"link\":\"/reference/utils/storage\"},{\"text\":\"Vue 与浏览器工具\",\"link\":\"/reference/utils/browser\"}]},{\"text\":\"应用配置\",\"link\":\"/reference/configuration\"},{\"text\":\"文档与源码版本\",\"link\":\"/reference/source\"}],\"/\":[{\"text\":\"入门\",\"items\":[{\"text\":\"快速开始\",\"link\":\"/guide/start\"},{\"text\":\"v6 Monorepo 架构\",\"link\":\"/guide/architecture\"},{\"text\":\"v5 与 v6 的版本分界\",\"link\":\"/migration\"},{\"text\":\"第一个业务页面\",\"link\":\"/guide/first-page\"}]},{\"text\":\"开发指南\",\"items\":[{\"text\":\"路由、菜单与权限\",\"link\":\"/guide/routing\"},{\"text\":\"应用布局与状态\",\"link\":\"/guide/layout\"},{\"text\":\"接口、取消与 Mock\",\"link\":\"/guide/requests\"},{\"text\":\"主题与国际化\",\"link\":\"/guide/appearance\"},{\"text\":\"工程检查与部署\",\"link\":\"/guide/tooling\"}]},{\"text\":\"API 参考\",\"link\":\"/reference/\"}]},\"outline\":{\"label\":\"本页目录\",\"level\":[2,3]},\"search\":{\"provider\":\"local\",\"options\":{\"translations\":{\"button\":{\"buttonText\":\"搜索文档\",\"buttonAriaLabel\":\"搜索文档\"},\"modal\":{\"noResultsText\":\"未找到相关内容\",\"resetButtonTitle\":\"清除搜索\",\"footer\":{\"selectText\":\"打开\",\"navigateText\":\"切换\",\"closeText\":\"关闭\"}}}}},\"skipToContentLabel\":\"跳转到正文\",\"docFooter\":{\"prev\":\"上一页\",\"next\":\"下一页\"},\"returnToTopLabel\":\"回到顶部\",\"sidebarMenuLabel\":\"文档目录\",\"darkModeSwitchLabel\":\"主题\",\"lightModeSwitchTitle\":\"切换到浅色\",\"darkModeSwitchTitle\":\"切换到深色\",\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/XiaoDaiGua-Ray/ray-template\"}],\"footer\":{\"copyright\":\"© 2022–至今 Ray · MIT License\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
|
||
|
||
</body>
|
||
</html> |