API Reference

这一页只做导出索引。

每个 API 后面都附一行中文说明和对应跳转页，适合快速查名字、用途和入口。

App 与配置

API	说明	跳转
`createUni()`	创建应用 runtime，把路由、请求、鉴权、模块等能力收进同一个应用容器	应用生命周期
`installUniApp()`	把创建好的 runtime 安装到 Vue app	应用生命周期
`setupUniAppLifecycle()`	把 uni-app 生命周期绑定到 runtime	应用生命周期
`defineUniConfig()`	定义传给 `createUni()` 的运行时配置	初始化配置
`definePageMeta()`	定义页面 Route 的辅助方法	页面 Route
`useUniApp()`	读取当前已安装的应用 runtime	应用生命周期
`useDux()`	`useUniApp()` 的同层入口，语义上更贴近 Dux runtime	应用生命周期
`useThemeStore()`	读取主题偏好 store，管理 `system / light / dark` 模式	主题与 Token
`useThemePreference()`	主题模式的轻量 composable，返回当前主题值和切换动作	主题与 Token

API	说明	跳转
`useRouter()`	统一页面跳转入口，会自动处理普通页和 tabBar 页	useRouter
`useNavigator()`	`useRouter()` 的兼容别名	useRouter
`useRoute()`	读取当前页面路径、query、页面名、模块名和 meta	useRoute
`usePageTitle()`	设置当前页面标题，支持响应式标题	usePageTitle
`usePageGuard()`	页面内做简单登录保护或游客页保护	usePageGuard
`useModules()`	读取当前已注册的模块列表	模块系统
`useActions()`	读取 action registry，并执行运行时 action	扩展机制
`useAction()`	读取并执行单个 action	扩展机制

API	说明	跳转
`useList()`	标准分页列表查询	useList
`useInfiniteList()`	无限滚动列表查询	useInfiniteList
`useOne()`	单条详情查询	useOne
`useMany()`	批量 id 查询和回填	useMany
`useCustom()`	读取型自定义 query	useCustom
`useCreate()`	创建型 mutation，适合新增数据	useCreate
`useUpdate()`	更新型 mutation，适合编辑数据	useUpdate
`useDelete()`	删除型 mutation	useDelete
`useCustomMutation()`	提交型自定义 mutation，适合命令式动作	useCustomMutation
`useInvalidate()`	让指定 query 缓存失效、重置或移除	useInvalidate
`useRefetch()`	主动刷新指定 query	useRefetch
`getQueryKey()`	生成统一 query key	数据查询
`simpleDataProvider()`	默认数据 provider，统一资源式请求	数据查询
`createUniNetworkAdapter()`	基于 `@uni-helper/uni-network` 的默认 adapter	请求配置
`createRequestClient()`	构造底层请求客户端，支持 header、sign、拦截器和 adapter	请求配置

API	说明	跳转
`defineUniModule()`	定义模块入口	模块系统
`mergeUniModules()`	合并模块 pages、layouts、actions 和 schema	模块系统
`mergeUniConfigPatch()`	合并模块级配置 patch	模块系统
`createSocketBridge()`	把 socket 消息桥接成业务事件	实战 Recipes
`useJsonSchema()`	JSON Schema 渲染入口	Schema 渲染
`UniSchemaRenderer`	底层 Schema 渲染组件	Schema 渲染
`createSchemaRenderer()`	创建底层 Schema renderer	Schema 渲染
`renderSchema()`	直接渲染 schema 为 VNode	Schema 渲染
`registerSchemaComponents()`	注册 schema 可用组件	Schema 渲染
`defineSchemaComponents()`	定义 schema 组件注册表	Schema 渲染
`createActionRegistry()`	创建 action registry	扩展机制
`createEventBus()`	创建 event bus	扩展机制
`createHookRegistry()`	创建 hook registry	扩展机制
`createMiddlewareRegistry()`	创建 middleware registry	页面运行时
`createOverlayRuntime()`	创建 overlay runtime	Overlay
`createRouter()`	创建 router runtime	路由与运行时
`createNavigator()`	创建 navigator runtime	路由与运行时
`createSessionManager()`	创建 session manager	认证与会话
`createSocketManager()`	创建全局 socket manager	useSocketManager
`createUniQueryClient()`	创建 query client	数据查询