outline: deep
运行时 API 示例
本页面演示了 VitePress 提供的一些运行时 API 的用法。
主要的 useData() API 可用于访问当前页面的站点、主题和页面数据。它在 .md 和 .vue 文件中均可工作：
md
<script setup>
import { useData } from 'vitepress'
const { theme, page, frontmatter } = useData()
</script>
## 结果
### 主题数据
<pre>{{ theme }}</pre>
### 页面数据
<pre>{{ page }}</pre>
### 页面 Frontmatter
<pre>{{ frontmatter }}</pre>结果
主题数据
{
"outline": {
"level": [
1,
3
]
},
"nav": [
{
"text": "Home",
"link": "/"
},
{
"text": "中文",
"link": "/zh"
},
{
"text": "English",
"link": "/en"
}
],
"sidebar": {
"/en/": [
{
"text": "bmad-method",
"collapsed": true,
"items": [
{
"text": "BMGD Quick Guide",
"collapsed": true,
"items": [
{
"text": "Game types",
"link": "/en/bmad-method/bmgd/game-types"
},
{
"text": "Quick flow workflows",
"link": "/en/bmad-method/bmgd/quick-flow-workflows"
}
]
},
{
"text": "Explanation",
"collapsed": true,
"items": [
{
"text": "Advanced elicitation",
"link": "/en/bmad-method/explanation/advanced-elicitation"
},
{
"text": "Adversarial review",
"link": "/en/bmad-method/explanation/adversarial-review"
},
{
"text": "Brainstorming",
"link": "/en/bmad-method/explanation/brainstorming"
},
{
"text": "Brownfield faq",
"link": "/en/bmad-method/explanation/brownfield-faq"
},
{
"text": "Party mode",
"link": "/en/bmad-method/explanation/party-mode"
},
{
"text": "Preventing agent conflicts",
"link": "/en/bmad-method/explanation/preventing-agent-conflicts"
},
{
"text": "Quick flow",
"link": "/en/bmad-method/explanation/quick-flow"
},
{
"text": "Why solutioning matters",
"link": "/en/bmad-method/explanation/why-solutioning-matters"
}
]
},
{
"text": "How-to",
"collapsed": true,
"items": [
{
"text": "brownfield",
"collapsed": true,
"items": [
{
"text": "Quick fix in brownfield",
"link": "/en/bmad-method/how-to/brownfield/quick-fix-in-brownfield"
}
]
},
{
"text": "Customize bmad",
"link": "/en/bmad-method/how-to/customize-bmad"
},
{
"text": "Get answers about bmad",
"link": "/en/bmad-method/how-to/get-answers-about-bmad"
},
{
"text": "Install bmad",
"link": "/en/bmad-method/how-to/install-bmad"
},
{
"text": "Shard large documents",
"link": "/en/bmad-method/how-to/shard-large-documents"
},
{
"text": "_bmad/_config/agents/bmm-pm.customize.yaml",
"link": "/en/bmad-method/how-to/upgrade-to-v6"
}
]
},
{
"text": "Reference",
"collapsed": true,
"items": [
{
"text": "Workflow map",
"link": "/en/bmad-method/reference/workflow-map"
}
]
},
{
"text": "Tutorials",
"collapsed": true,
"items": [
{
"text": "Getting started",
"link": "/en/bmad-method/tutorials/getting-started"
}
]
},
{
"text": "404",
"link": "/en/bmad-method/404"
},
{
"text": "Include in your system prompt or context",
"link": "/en/bmad-method/downloads"
}
]
},
{
"text": "Openspec",
"collapsed": true,
"items": [
{
"text": "CLI Reference",
"link": "/en/openspec/cli"
},
{
"text": "Commands",
"link": "/en/openspec/commands"
},
{
"text": "Concepts",
"link": "/en/openspec/concepts"
},
{
"text": "Customization",
"link": "/en/openspec/customization"
},
{
"text": "Getting Started",
"link": "/en/openspec/getting-started"
},
{
"text": "Installation",
"link": "/en/openspec/installation"
},
{
"text": "Migrating to OPSX",
"link": "/en/openspec/migration-guide"
},
{
"text": "Multi-Language Guide",
"link": "/en/openspec/multi-language"
},
{
"text": "OPSX Workflow",
"link": "/en/openspec/opsx"
},
{
"text": "Supported Tools",
"link": "/en/openspec/supported-tools"
},
{
"text": "Workflows",
"link": "/en/openspec/workflows"
}
]
},
{
"text": "Spec Kit",
"collapsed": true,
"items": [
{
"text": "Installation Guide",
"link": "/en/spec-kit/installation"
},
{
"text": "Local Development Guide",
"link": "/en/spec-kit/local-development"
},
{
"text": "Quick Start Guide",
"link": "/en/spec-kit/quickstart"
},
{
"text": "Documentation",
"link": "/en/spec-kit/README"
},
{
"text": "Upgrade Guide",
"link": "/en/spec-kit/upgrade"
}
]
},
{
"text": "Vitepress",
"collapsed": true,
"items": [
{
"text": "Advanced",
"collapsed": true,
"items": [
{
"text": "Code Highlighting",
"link": "/en/vitepress/advanced/code-highlighting"
},
{
"text": "Custom Theme",
"link": "/en/vitepress/advanced/custom-theme"
},
{
"text": "Markdown Extensions",
"link": "/en/vitepress/advanced/markdown-extensions"
}
]
},
{
"text": "Examples",
"collapsed": true,
"items": [
{
"text": "Runtime API Examples",
"link": "/en/vitepress/examples/api-examples"
},
{
"text": "Markdown Extension Examples",
"link": "/en/vitepress/examples/markdown-examples"
}
]
},
{
"text": "Quick-start",
"collapsed": true,
"items": [
{
"text": "Quick Start",
"link": "/en/vitepress/quick-start/quick-start"
}
]
}
]
},
{
"text": "Xcbi Dev",
"collapsed": true,
"items": [
{
"text": "Ai And Machine Learning Components",
"collapsed": true,
"items": [
{
"text": "Multi Agent System Architecture",
"collapsed": true,
"items": [
{
"text": "Agent Communication and Coordination",
"link": "/en/xcbi-dev/ai-and-machine-learning-components/multi-agent-system-architecture/agent-communication-and-coordination"
},
{
"text": "Agent Types and Responsibilities",
"link": "/en/xcbi-dev/ai-and-machine-learning-components/multi-agent-system-architecture/agent-types-and-responsibilities"
},
{
"text": "Conversation Management System",
"link": "/en/xcbi-dev/ai-and-machine-learning-components/multi-agent-system-architecture/conversation-management-system"
},
{
"text": "Multi-Agent System Architecture",
"link": "/en/xcbi-dev/ai-and-machine-learning-components/multi-agent-system-architecture/multi-agent-system-architecture"
},
{
"text": "Workflow Orchestration and Pipeline",
"link": "/en/xcbi-dev/ai-and-machine-learning-components/multi-agent-system-architecture/workflow-orchestration-and-pipeline"
}
]
},
{
"text": "AI and Machine Learning Components",
"link": "/en/xcbi-dev/ai-and-machine-learning-components/ai-and-machine-learning-components"
},
{
"text": "Knowledge Graph and Semantic Search",
"link": "/en/xcbi-dev/ai-and-machine-learning-components/knowledge-graph-and-semantic-search"
},
{
"text": "Natural Language to SQL Integration",
"link": "/en/xcbi-dev/ai-and-machine-learning-components/natural-language-to-sql-integration"
},
{
"text": "Specialized AI Database Server",
"link": "/en/xcbi-dev/ai-and-machine-learning-components/specialized-ai-database-server"
}
]
},
{
"text": "Api Reference Documentation",
"collapsed": true,
"items": [
{
"text": "API Client Libraries and SDKs",
"link": "/en/xcbi-dev/api-reference-documentation/api-client-libraries-and-sdks"
},
{
"text": "API Reference Documentation",
"link": "/en/xcbi-dev/api-reference-documentation/api-reference-documentation"
},
{
"text": "Authentication and Security",
"link": "/en/xcbi-dev/api-reference-documentation/authentication-and-security"
},
{
"text": "gRPC Service Definitions",
"link": "/en/xcbi-dev/api-reference-documentation/grpc-service-definitions"
},
{
"text": "REST API Endpoints",
"link": "/en/xcbi-dev/api-reference-documentation/rest-api-endpoints"
}
]
},
{
"text": "Architecture Documentation",
"collapsed": true,
"items": [
{
"text": "Data Flow And Processing Architecture",
"collapsed": true,
"items": [
{
"text": "Data Flow and Processing Architecture",
"link": "/en/xcbi-dev/architecture-documentation/data-flow-and-processing-architecture/data-flow-and-processing-architecture"
},
{
"text": "Data Ingestion and Processing Pipeline",
"link": "/en/xcbi-dev/architecture-documentation/data-flow-and-processing-architecture/data-ingestion-and-processing-pipeline"
},
{
"text": "Data Quality and Performance Optimization",
"link": "/en/xcbi-dev/architecture-documentation/data-flow-and-processing-architecture/data-quality-and-performance-optimization"
},
{
"text": "Event-Driven Processing with Kafka",
"link": "/en/xcbi-dev/architecture-documentation/data-flow-and-processing-architecture/event-driven-processing-with-kafka"
},
{
"text": "StarRocks OLAP Database Architecture",
"link": "/en/xcbi-dev/architecture-documentation/data-flow-and-processing-architecture/starrocks-olap-database-architecture"
}
]
},
{
"text": "Microservices Architecture And Design Patterns",
"collapsed": true,
"items": [
{
"text": "Architectural Enforcement and Consistency",
"link": "/en/xcbi-dev/architecture-documentation/microservices-architecture-and-design-patterns/architectural-enforcement-and-consistency"
},
{
"text": "Microservices Architecture and Design Patterns",
"link": "/en/xcbi-dev/architecture-documentation/microservices-architecture-and-design-patterns/microservices-architecture-and-design-patterns"
},
{
"text": "Service Architecture Patterns and Boundaries",
"link": "/en/xcbi-dev/architecture-documentation/microservices-architecture-and-design-patterns/service-architecture-patterns-and-boundaries"
},
{
"text": "Service Communication Protocols",
"link": "/en/xcbi-dev/architecture-documentation/microservices-architecture-and-design-patterns/service-communication-protocols"
},
{
"text": "Service Discovery and Configuration Management",
"link": "/en/xcbi-dev/architecture-documentation/microservices-architecture-and-design-patterns/service-discovery-and-configuration-management"
}
]
},
{
"text": "Architecture Documentation",
"link": "/en/xcbi-dev/architecture-documentation/architecture-documentation"
},
{
"text": "Infrastructure and Deployment Architecture",
"link": "/en/xcbi-dev/architecture-documentation/infrastructure-and-deployment-architecture"
},
{
"text": "Integration Patterns and External Systems",
"link": "/en/xcbi-dev/architecture-documentation/integration-patterns-and-external-systems"
},
{
"text": "System Overview and Context",
"link": "/en/xcbi-dev/architecture-documentation/system-overview-and-context"
}
]
},
{
"text": "Backend Services",
"collapsed": true,
"items": [
{
"text": "Core Services",
"collapsed": true,
"items": [
{
"text": "Bi Analysis Analytics Engine",
"collapsed": true,
"items": [
{
"text": "Analytical Processing and Data Transformation",
"link": "/en/xcbi-dev/backend-services/core-services/bi-analysis-analytics-engine/analytical-processing-and-data-transformation"
},
{
"text": "Analytics Engine Overview",
"link": "/en/xcbi-dev/backend-services/core-services/bi-analysis-analytics-engine/analytics-engine-overview"
},
{
"text": "API Endpoints and Service Interfaces",
"link": "/en/xcbi-dev/backend-services/core-services/bi-analysis-analytics-engine/api-endpoints-and-service-interfaces"
},
{
"text": "bi-analysis - Analytics Engine",
"link": "/en/xcbi-dev/backend-services/core-services/bi-analysis-analytics-engine/bi-analysis-analytics-engine"
},
{
"text": "Configuration and Deployment",
"link": "/en/xcbi-dev/backend-services/core-services/bi-analysis-analytics-engine/configuration-and-deployment"
},
{
"text": "Database Schema and Data Model",
"link": "/en/xcbi-dev/backend-services/core-services/bi-analysis-analytics-engine/database-schema-and-data-model"
}
]
},
{
"text": "Bi Basic Foundation Data Services",
"collapsed": true,
"items": [
{
"text": "Architecture and Design",
"link": "/en/xcbi-dev/backend-services/core-services/bi-basic-foundation-data-services/architecture-and-design"
},
{
"text": "bi-basic - Foundation Data Services",
"link": "/en/xcbi-dev/backend-services/core-services/bi-basic-foundation-data-services/bi-basic-foundation-data-services"
},
{
"text": "Business Logic Implementation",
"link": "/en/xcbi-dev/backend-services/core-services/bi-basic-foundation-data-services/business-logic-implementation"
},
{
"text": "Configuration and Deployment",
"link": "/en/xcbi-dev/backend-services/core-services/bi-basic-foundation-data-services/configuration-and-deployment"
},
{
"text": "Data Models and Entities",
"link": "/en/xcbi-dev/backend-services/core-services/bi-basic-foundation-data-services/data-models-and-entities"
},
{
"text": "External System Integrations",
"link": "/en/xcbi-dev/backend-services/core-services/bi-basic-foundation-data-services/external-system-integrations"
}
]
},
{
"text": "Bi Server Business Orchestration Center",
"collapsed": true,
"items": [
{
"text": "bi-server - Business Orchestration Center",
"link": "/en/xcbi-dev/backend-services/core-services/bi-server-business-orchestration-center/bi-server-business-orchestration-center"
},
{
"text": "Configuration Management",
"link": "/en/xcbi-dev/backend-services/core-services/bi-server-business-orchestration-center/configuration-management"
},
{
"text": "Dependency Injection and Wiring",
"link": "/en/xcbi-dev/backend-services/core-services/bi-server-business-orchestration-center/dependency-injection-and-wiring"
},
{
"text": "Deployment and Operations",
"link": "/en/xcbi-dev/backend-services/core-services/bi-server-business-orchestration-center/deployment-and-operations"
},
{
"text": "Service Overview and Architecture",
"link": "/en/xcbi-dev/backend-services/core-services/bi-server-business-orchestration-center/service-overview-and-architecture"
}
]
},
{
"text": "Core Services",
"link": "/en/xcbi-dev/backend-services/core-services/core-services"
}
]
},
{
"text": "Management Services",
"collapsed": true,
"items": [
{
"text": "Bi Sys System Management Service",
"collapsed": true,
"items": [
{
"text": "Authentication and Authorization Service",
"link": "/en/xcbi-dev/backend-services/management-services/bi-sys-system-management-service/authentication-and-authorization-service"
},
{
"text": "bi-sys System Management Service",
"link": "/en/xcbi-dev/backend-services/management-services/bi-sys-system-management-service/bi-sys-system-management-service"
},
{
"text": "Menu and Navigation Management",
"link": "/en/xcbi-dev/backend-services/management-services/bi-sys-system-management-service/menu-and-navigation-management"
},
{
"text": "Role-Based Access Control (RBAC)",
"link": "/en/xcbi-dev/backend-services/management-services/bi-sys-system-management-service/role-based-access-control-rbac"
},
{
"text": "System Configuration Management",
"link": "/en/xcbi-dev/backend-services/management-services/bi-sys-system-management-service/system-configuration-management"
},
{
"text": "User Management System",
"link": "/en/xcbi-dev/backend-services/management-services/bi-sys-system-management-service/user-management-system"
}
]
},
{
"text": "Bi Tenant Multi Tenant Management Service",
"collapsed": true,
"items": [
{
"text": "Bi-tenant Multi-Tenant Management Service",
"link": "/en/xcbi-dev/backend-services/management-services/bi-tenant-multi-tenant-management-service/bi-tenant-multi-tenant-management-service"
},
{
"text": "Database Schema and Data Model",
"link": "/en/xcbi-dev/backend-services/management-services/bi-tenant-multi-tenant-management-service/database-schema-and-data-model"
},
{
"text": "Multi-Tenant Architecture",
"link": "/en/xcbi-dev/backend-services/management-services/bi-tenant-multi-tenant-management-service/multi-tenant-architecture"
},
{
"text": "Organization Management",
"link": "/en/xcbi-dev/backend-services/management-services/bi-tenant-multi-tenant-management-service/organization-management"
},
{
"text": "Tenant Authentication and Authorization",
"link": "/en/xcbi-dev/backend-services/management-services/bi-tenant-multi-tenant-management-service/tenant-authentication-and-authorization"
},
{
"text": "Tenant Management API",
"link": "/en/xcbi-dev/backend-services/management-services/bi-tenant-multi-tenant-management-service/tenant-management-api"
}
]
},
{
"text": "Bi-Cron Distributed Task Scheduling Service",
"link": "/en/xcbi-dev/backend-services/management-services/bi-cron-distributed-task-scheduling-service"
},
{
"text": "Management Services",
"link": "/en/xcbi-dev/backend-services/management-services/management-services"
}
]
},
{
"text": "Shared Infrastructure",
"collapsed": true,
"items": [
{
"text": "API Types & Error Handling",
"link": "/en/xcbi-dev/backend-services/shared-infrastructure/api-types-error-handling"
},
{
"text": "Authentication & Authorization",
"link": "/en/xcbi-dev/backend-services/shared-infrastructure/authentication-authorization"
},
{
"text": "Database Abstraction (GORMx)",
"link": "/en/xcbi-dev/backend-services/shared-infrastructure/database-abstraction-gormx"
},
{
"text": "Messaging System (Kafkax)",
"link": "/en/xcbi-dev/backend-services/shared-infrastructure/messaging-system-kafkax"
},
{
"text": "Redis Caching (Redisx)",
"link": "/en/xcbi-dev/backend-services/shared-infrastructure/redis-caching-redisx"
},
{
"text": "Service Discovery (Nacos)",
"link": "/en/xcbi-dev/backend-services/shared-infrastructure/service-discovery-nacos"
},
{
"text": "Shared Infrastructure",
"link": "/en/xcbi-dev/backend-services/shared-infrastructure/shared-infrastructure"
},
{
"text": "Utilities & Helpers",
"link": "/en/xcbi-dev/backend-services/shared-infrastructure/utilities-helpers"
}
]
},
{
"text": "Backend Services",
"link": "/en/xcbi-dev/backend-services/backend-services"
},
{
"text": "Specialized Services",
"link": "/en/xcbi-dev/backend-services/specialized-services"
}
]
},
{
"text": "Database And Data Architecture",
"collapsed": true,
"items": [
{
"text": "External Data Integration",
"collapsed": true,
"items": [
{
"text": "Jushuitan Erp Integration",
"collapsed": true,
"items": [
{
"text": "Authentication and Security",
"link": "/en/xcbi-dev/database-and-data-architecture/external-data-integration/jushuitan-erp-integration/authentication-and-security"
},
{
"text": "Goods Catalog Integration",
"link": "/en/xcbi-dev/database-and-data-architecture/external-data-integration/jushuitan-erp-integration/goods-catalog-integration"
},
{
"text": "Inventory Management",
"link": "/en/xcbi-dev/database-and-data-architecture/external-data-integration/jushuitan-erp-integration/inventory-management"
},
{
"text": "Jushuitan ERP Integration",
"link": "/en/xcbi-dev/database-and-data-architecture/external-data-integration/jushuitan-erp-integration/jushuitan-erp-integration"
},
{
"text": "Order Synchronization",
"link": "/en/xcbi-dev/database-and-data-architecture/external-data-integration/jushuitan-erp-integration/order-synchronization"
}
]
},
{
"text": "Leke Erp Integration",
"collapsed": true,
"items": [
{
"text": "Data Transformation and Mapping",
"link": "/en/xcbi-dev/database-and-data-architecture/external-data-integration/leke-erp-integration/data-transformation-and-mapping"
},
{
"text": "Leke ERP Integration",
"link": "/en/xcbi-dev/database-and-data-architecture/external-data-integration/leke-erp-integration/leke-erp-integration"
},
{
"text": "Order Data Synchronization",
"link": "/en/xcbi-dev/database-and-data-architecture/external-data-integration/leke-erp-integration/order-data-synchronization"
},
{
"text": "Product Catalog Synchronization",
"link": "/en/xcbi-dev/database-and-data-architecture/external-data-integration/leke-erp-integration/product-catalog-synchronization"
},
{
"text": "Refund and Return Processing",
"link": "/en/xcbi-dev/database-and-data-architecture/external-data-integration/leke-erp-integration/refund-and-return-processing"
},
{
"text": "Taobao API Client Implementation",
"link": "/en/xcbi-dev/database-and-data-architecture/external-data-integration/leke-erp-integration/taobao-api-client-implementation"
}
]
},
{
"text": "Data Synchronization Patterns",
"link": "/en/xcbi-dev/database-and-data-architecture/external-data-integration/data-synchronization-patterns"
},
{
"text": "External Data Integration",
"link": "/en/xcbi-dev/database-and-data-architecture/external-data-integration/external-data-integration"
},
{
"text": "Taobao Advertising Integration",
"link": "/en/xcbi-dev/database-and-data-architecture/external-data-integration/taobao-advertising-integration"
}
]
},
{
"text": "Kafka Data Synchronization Pipeline",
"collapsed": true,
"items": [
{
"text": "Kafka Configuration and Monitoring",
"link": "/en/xcbi-dev/database-and-data-architecture/kafka-data-synchronization-pipeline/kafka-configuration-and-monitoring"
},
{
"text": "Kafka Data Synchronization Pipeline",
"link": "/en/xcbi-dev/database-and-data-architecture/kafka-data-synchronization-pipeline/kafka-data-synchronization-pipeline"
},
{
"text": "Kafka Producer and Consumer Implementation",
"link": "/en/xcbi-dev/database-and-data-architecture/kafka-data-synchronization-pipeline/kafka-producer-and-consumer-implementation"
},
{
"text": "Message Processing and Transformation Pipeline",
"link": "/en/xcbi-dev/database-and-data-architecture/kafka-data-synchronization-pipeline/message-processing-and-transformation-pipeline"
},
{
"text": "Multi-Consumer and Parallel Processing",
"link": "/en/xcbi-dev/database-and-data-architecture/kafka-data-synchronization-pipeline/multi-consumer-and-parallel-processing"
}
]
},
{
"text": "Starrocks Olap Database",
"collapsed": true,
"items": [
{
"text": "Data Loading and Optimization",
"link": "/en/xcbi-dev/database-and-data-architecture/starrocks-olap-database/data-loading-and-optimization"
},
{
"text": "Database Schema Overview",
"link": "/en/xcbi-dev/database-and-data-architecture/starrocks-olap-database/database-schema-overview"
},
{
"text": "Date Dimension Implementation",
"link": "/en/xcbi-dev/database-and-data-architecture/starrocks-olap-database/date-dimension-implementation"
},
{
"text": "Partitioning and Indexing Strategies",
"link": "/en/xcbi-dev/database-and-data-architecture/starrocks-olap-database/partitioning-and-indexing-strategies"
},
{
"text": "StarRocks OLAP Database",
"link": "/en/xcbi-dev/database-and-data-architecture/starrocks-olap-database/starrocks-olap-database"
}
]
},
{
"text": "Data Governance and Monitoring",
"link": "/en/xcbi-dev/database-and-data-architecture/data-governance-and-monitoring"
},
{
"text": "Database and Data Architecture",
"link": "/en/xcbi-dev/database-and-data-architecture/database-and-data-architecture"
}
]
},
{
"text": "Frontend Applications",
"collapsed": true,
"items": [
{
"text": "Admin Panel Ui Web Admin",
"collapsed": true,
"items": [
{
"text": "Admin Panel Overview",
"link": "/en/xcbi-dev/frontend-applications/admin-panel-ui-web-admin/admin-panel-overview"
},
{
"text": "Admin Panel (ui-web-admin)",
"link": "/en/xcbi-dev/frontend-applications/admin-panel-ui-web-admin/admin-panel-ui-web-admin"
},
{
"text": "Audit and Compliance",
"link": "/en/xcbi-dev/frontend-applications/admin-panel-ui-web-admin/audit-and-compliance"
},
{
"text": "Monitoring and Analytics",
"link": "/en/xcbi-dev/frontend-applications/admin-panel-ui-web-admin/monitoring-and-analytics"
},
{
"text": "System Configuration",
"link": "/en/xcbi-dev/frontend-applications/admin-panel-ui-web-admin/system-configuration"
},
{
"text": "Tenant Administration",
"link": "/en/xcbi-dev/frontend-applications/admin-panel-ui-web-admin/tenant-administration"
},
{
"text": "User Management System",
"link": "/en/xcbi-dev/frontend-applications/admin-panel-ui-web-admin/user-management-system"
}
]
},
{
"text": "Tenant Console Ui Web",
"collapsed": true,
"items": [
{
"text": "API Integration and Data Fetching",
"link": "/en/xcbi-dev/frontend-applications/tenant-console-ui-web/api-integration-and-data-fetching"
},
{
"text": "Component Library and UI Patterns",
"link": "/en/xcbi-dev/frontend-applications/tenant-console-ui-web/component-library-and-ui-patterns"
},
{
"text": "Dashboard System",
"link": "/en/xcbi-dev/frontend-applications/tenant-console-ui-web/dashboard-system"
},
{
"text": "Metric Management Interface",
"link": "/en/xcbi-dev/frontend-applications/tenant-console-ui-web/metric-management-interface"
},
{
"text": "Navigation and Routing",
"link": "/en/xcbi-dev/frontend-applications/tenant-console-ui-web/navigation-and-routing"
},
{
"text": "State Management Architecture",
"link": "/en/xcbi-dev/frontend-applications/tenant-console-ui-web/state-management-architecture"
},
{
"text": "Tenant Console (ui-web)",
"link": "/en/xcbi-dev/frontend-applications/tenant-console-ui-web/tenant-console-ui-web"
},
{
"text": "User Authentication and Authorization",
"link": "/en/xcbi-dev/frontend-applications/tenant-console-ui-web/user-authentication-and-authorization"
}
]
},
{
"text": "Browser Extension (ui-crx)",
"link": "/en/xcbi-dev/frontend-applications/browser-extension-ui-crx"
},
{
"text": "Frontend Applications",
"link": "/en/xcbi-dev/frontend-applications/frontend-applications"
},
{
"text": "Navigation Components (ui-web-top)",
"link": "/en/xcbi-dev/frontend-applications/navigation-components-ui-web-top"
}
]
},
{
"text": "Project Overview",
"collapsed": true,
"items": [
{
"text": "Architecture Overview",
"link": "/en/xcbi-dev/project-overview/architecture-overview"
},
{
"text": "Feature Showcase",
"link": "/en/xcbi-dev/project-overview/feature-showcase"
},
{
"text": "Getting Started",
"link": "/en/xcbi-dev/project-overview/getting-started"
},
{
"text": "Project Overview",
"link": "/en/xcbi-dev/project-overview/project-overview"
},
{
"text": "Technology Stack",
"link": "/en/xcbi-dev/project-overview/technology-stack"
}
]
},
{
"text": "Deployment and Operations",
"link": "/en/xcbi-dev/deployment-and-operations"
},
{
"text": "Development and Testing",
"link": "/en/xcbi-dev/development-and-testing"
},
{
"text": "Getting Started",
"link": "/en/xcbi-dev/getting-started"
},
{
"text": "Troubleshooting and Maintenance",
"link": "/en/xcbi-dev/troubleshooting-and-maintenance"
}
]
}
],
"/zh/": [
{
"text": "bmad-method",
"collapsed": true,
"items": [
{
"text": "BMGD 快速指南",
"collapsed": true,
"items": [
{
"text": "Game types",
"link": "/zh/bmad-method/bmgd/game-types"
},
{
"text": "Quick flow workflows",
"link": "/zh/bmad-method/bmgd/quick-flow-workflows"
}
]
},
{
"text": "Explanation",
"collapsed": true,
"items": [
{
"text": "Advanced elicitation",
"link": "/zh/bmad-method/explanation/advanced-elicitation"
},
{
"text": "Adversarial review",
"link": "/zh/bmad-method/explanation/adversarial-review"
},
{
"text": "Brainstorming",
"link": "/zh/bmad-method/explanation/brainstorming"
},
{
"text": "Brownfield faq",
"link": "/zh/bmad-method/explanation/brownfield-faq"
},
{
"text": "Party mode",
"link": "/zh/bmad-method/explanation/party-mode"
},
{
"text": "Preventing agent conflicts",
"link": "/zh/bmad-method/explanation/preventing-agent-conflicts"
},
{
"text": "Quick flow",
"link": "/zh/bmad-method/explanation/quick-flow"
},
{
"text": "Why solutioning matters",
"link": "/zh/bmad-method/explanation/why-solutioning-matters"
}
]
},
{
"text": "How-to",
"collapsed": true,
"items": [
{
"text": "brownfield",
"collapsed": true,
"items": [
{
"text": "Quick fix in brownfield",
"link": "/zh/bmad-method/how-to/brownfield/quick-fix-in-brownfield"
}
]
},
{
"text": "Customize bmad",
"link": "/zh/bmad-method/how-to/customize-bmad"
},
{
"text": "Get answers about bmad",
"link": "/zh/bmad-method/how-to/get-answers-about-bmad"
},
{
"text": "Install bmad",
"link": "/zh/bmad-method/how-to/install-bmad"
},
{
"text": "Shard large documents",
"link": "/zh/bmad-method/how-to/shard-large-documents"
},
{
"text": "_bmad/_config/agents/bmm-pm.customize.yaml",
"link": "/zh/bmad-method/how-to/upgrade-to-v6"
}
]
},
{
"text": "Reference",
"collapsed": true,
"items": [
{
"text": "Workflow map",
"link": "/zh/bmad-method/reference/workflow-map"
}
]
},
{
"text": "Tutorials",
"collapsed": true,
"items": [
{
"text": "Getting started",
"link": "/zh/bmad-method/tutorials/getting-started"
}
]
},
{
"text": "404",
"link": "/zh/bmad-method/404"
},
{
"text": "Include in your system prompt or context",
"link": "/zh/bmad-method/downloads"
}
]
},
{
"text": "Openspec",
"collapsed": true,
"items": [
{
"text": "CLI 参考",
"link": "/zh/openspec/cli"
},
{
"text": "命令",
"link": "/zh/openspec/commands"
},
{
"text": "概念",
"link": "/zh/openspec/concepts"
},
{
"text": "自定义",
"link": "/zh/openspec/customization"
},
{
"text": "新手入门",
"link": "/zh/openspec/getting-started"
},
{
"text": "安装",
"link": "/zh/openspec/installation"
},
{
"text": "迁移指南",
"link": "/zh/openspec/migration-guide"
},
{
"text": "多语言指南",
"link": "/zh/openspec/multi-language"
},
{
"text": "OPSX 工作流",
"link": "/zh/openspec/opsx"
},
{
"text": "支持的工具",
"link": "/zh/openspec/supported-tools"
},
{
"text": "常见工作流",
"link": "/zh/openspec/workflows"
}
]
},
{
"text": "Spec Kit",
"collapsed": true,
"items": [
{
"text": "安装指南",
"link": "/zh/spec-kit/installation"
},
{
"text": "本地开发指南",
"link": "/zh/spec-kit/local-development"
},
{
"text": "快速入门指南",
"link": "/zh/spec-kit/quickstart"
},
{
"text": "文档",
"link": "/zh/spec-kit/README"
},
{
"text": "升级指南",
"link": "/zh/spec-kit/upgrade"
}
]
},
{
"text": "Vitepress",
"collapsed": true,
"items": [
{
"text": "Advanced",
"collapsed": true,
"items": [
{
"text": "代码高亮",
"link": "/zh/vitepress/advanced/code-highlighting"
},
{
"text": "自定义主题",
"link": "/zh/vitepress/advanced/custom-theme"
},
{
"text": "Markdown 扩展",
"link": "/zh/vitepress/advanced/markdown-extensions"
}
]
},
{
"text": "Examples",
"collapsed": true,
"items": [
{
"text": "运行时 API 示例",
"link": "/zh/vitepress/examples/api-examples"
},
{
"text": "Markdown 扩展示例",
"link": "/zh/vitepress/examples/markdown-examples"
}
]
},
{
"text": "Quick-start",
"collapsed": true,
"items": [
{
"text": "快速开始",
"link": "/zh/vitepress/quick-start/quick-start"
}
]
}
]
},
{
"text": "Xcbi-dev",
"collapsed": true,
"items": [
{
"text": "AI智能体系统",
"collapsed": true,
"items": [
{
"text": "Agent架构设计",
"link": "/zh/xcbi-dev/ai/agent"
},
{
"text": "AI智能体系统",
"link": "/zh/xcbi-dev/ai/ai"
},
{
"text": "API集成与接口设计",
"link": "/zh/xcbi-dev/ai/api"
},
{
"text": "工具系统",
"link": "/zh/xcbi-dev/ai/工具系统"
},
{
"text": "记忆系统",
"link": "/zh/xcbi-dev/ai/记忆系统"
}
]
},
{
"text": "AI智能体系统",
"collapsed": true,
"items": [
{
"text": "Agent架构设计",
"link": "/zh/xcbi-dev/AI智能体系统/agent"
},
{
"text": "Agent架构设计",
"link": "/zh/xcbi-dev/AI智能体系统/Agent架构设计"
},
{
"text": "AI智能体系统",
"link": "/zh/xcbi-dev/AI智能体系统/ai"
},
{
"text": "AI智能体系统",
"link": "/zh/xcbi-dev/AI智能体系统/AI智能体系统"
},
{
"text": "API集成与接口设计",
"link": "/zh/xcbi-dev/AI智能体系统/api"
},
{
"text": "API集成与接口设计",
"link": "/zh/xcbi-dev/AI智能体系统/API集成与接口设计"
},
{
"text": "对话管理",
"link": "/zh/xcbi-dev/AI智能体系统/对话管理"
},
{
"text": "工具系统",
"link": "/zh/xcbi-dev/AI智能体系统/工具系统"
},
{
"text": "记忆系统",
"link": "/zh/xcbi-dev/AI智能体系统/记忆系统"
}
]
},
{
"text": "API参考文档",
"collapsed": true,
"items": [
{
"text": "API参考文档",
"link": "/zh/xcbi-dev/api/api"
},
{
"text": "分析服务API",
"link": "/zh/xcbi-dev/api/分析服务API"
},
{
"text": "基础服务API",
"link": "/zh/xcbi-dev/api/基础服务API"
},
{
"text": "数据同步API",
"link": "/zh/xcbi-dev/api/数据同步API"
},
{
"text": "系统服务API",
"link": "/zh/xcbi-dev/api/系统服务API"
},
{
"text": "聊天服务API",
"link": "/zh/xcbi-dev/api/聊天服务API"
},
{
"text": "通用API类型",
"link": "/zh/xcbi-dev/api/通用API类型"
}
]
},
{
"text": "API参考文档",
"collapsed": true,
"items": [
{
"text": "API参考文档",
"link": "/zh/xcbi-dev/API参考文档/api"
},
{
"text": "API参考文档",
"link": "/zh/xcbi-dev/API参考文档/API参考文档"
},
{
"text": "分析服务API",
"link": "/zh/xcbi-dev/API参考文档/分析服务API"
},
{
"text": "基础服务API",
"link": "/zh/xcbi-dev/API参考文档/基础服务API"
},
{
"text": "数据同步API",
"link": "/zh/xcbi-dev/API参考文档/数据同步API"
},
{
"text": "系统服务API",
"link": "/zh/xcbi-dev/API参考文档/系统服务API"
},
{
"text": "聊天服务API",
"link": "/zh/xcbi-dev/API参考文档/聊天服务API"
},
{
"text": "通用API类型",
"link": "/zh/xcbi-dev/API参考文档/通用API类型"
}
]
},
{
"text": "前端应用",
"collapsed": true,
"items": [
{
"text": "ui-crx 浏览器扩展",
"link": "/zh/xcbi-dev/前端应用/ui-crx 浏览器扩展"
},
{
"text": "ui-crx 浏览器扩展",
"link": "/zh/xcbi-dev/前端应用/ui-crx-"
},
{
"text": "ui-web 租户控制台",
"link": "/zh/xcbi-dev/前端应用/ui-web 租户控制台"
},
{
"text": "ui-web 租户控制台",
"link": "/zh/xcbi-dev/前端应用/ui-web-"
},
{
"text": "ui-web-admin 管理后台",
"link": "/zh/xcbi-dev/前端应用/ui-web-admin 管理后台"
},
{
"text": "ui-web-admin 管理后台",
"link": "/zh/xcbi-dev/前端应用/ui-web-admin-"
},
{
"text": "ui-web-top 顶部导航",
"link": "/zh/xcbi-dev/前端应用/ui-web-top 顶部导航"
},
{
"text": "ui-web-top 顶部导航",
"link": "/zh/xcbi-dev/前端应用/ui-web-top-"
},
{
"text": "前端应用",
"link": "/zh/xcbi-dev/前端应用/前端应用"
}
]
},
{
"text": "基础设施",
"collapsed": true,
"items": [
{
"text": "基础设施",
"link": "/zh/xcbi-dev/基础设施/基础设施"
},
{
"text": "数据库设计",
"link": "/zh/xcbi-dev/基础设施/数据库设计"
},
{
"text": "消息队列设计",
"link": "/zh/xcbi-dev/基础设施/消息队列设计"
},
{
"text": "监控与可观测性",
"link": "/zh/xcbi-dev/基础设施/监控与可观测性"
},
{
"text": "缓存策略",
"link": "/zh/xcbi-dev/基础设施/缓存策略"
},
{
"text": "配置管理",
"link": "/zh/xcbi-dev/基础设施/配置管理"
}
]
},
{
"text": "开发指南",
"collapsed": true,
"items": [
{
"text": "API设计规范",
"link": "/zh/xcbi-dev/开发指南/api"
},
{
"text": "API设计规范",
"link": "/zh/xcbi-dev/开发指南/API设计规范"
},
{
"text": "CI/CD流程",
"link": "/zh/xcbi-dev/开发指南/CI_CD流程"
},
{
"text": "CI/CD流程",
"link": "/zh/xcbi-dev/开发指南/ci-cd"
},
{
"text": "代码规范",
"link": "/zh/xcbi-dev/开发指南/代码规范"
},
{
"text": "开发指南",
"link": "/zh/xcbi-dev/开发指南/开发指南"
},
{
"text": "开发环境搭建",
"link": "/zh/xcbi-dev/开发指南/开发环境搭建"
},
{
"text": "测试策略",
"link": "/zh/xcbi-dev/开发指南/测试策略"
},
{
"text": "项目结构与模块化",
"link": "/zh/xcbi-dev/开发指南/项目结构与模块化"
}
]
},
{
"text": "核心服务模块",
"collapsed": true,
"items": [
{
"text": "bi-analysis 核心分析服务",
"link": "/zh/xcbi-dev/核心服务模块/bi-analysis 核心分析服务"
},
{
"text": "bi-analysis 核心分析服务",
"link": "/zh/xcbi-dev/核心服务模块/bi-analysis-"
},
{
"text": "bi-api-jushuitan 聚水潭数据同步",
"link": "/zh/xcbi-dev/核心服务模块/bi-api-jushuitan 聚水潭数据同步"
},
{
"text": "bi-api-jushuitan 聚水潭数据同步",
"link": "/zh/xcbi-dev/核心服务模块/bi-api-jushuitan-"
},
{
"text": "bi-api-leke 乐客数据同步",
"link": "/zh/xcbi-dev/核心服务模块/bi-api-leke 乐客数据同步"
},
{
"text": "bi-api-leke 乐客数据同步",
"link": "/zh/xcbi-dev/核心服务模块/bi-api-leke-"
},
{
"text": "bi-basic 基础数据服务",
"link": "/zh/xcbi-dev/核心服务模块/bi-basic 基础数据服务"
},
{
"text": "bi-basic 基础数据服务",
"link": "/zh/xcbi-dev/核心服务模块/bi-basic-"
},
{
"text": "bi-chat AI对话系统",
"link": "/zh/xcbi-dev/核心服务模块/bi-chat AI对话系统"
},
{
"text": "bi-chat AI对话系统",
"link": "/zh/xcbi-dev/核心服务模块/bi-chat-ai"
},
{
"text": "bi-cron 定时任务服务",
"link": "/zh/xcbi-dev/核心服务模块/bi-cron 定时任务服务"
},
{
"text": "bi-cron 定时任务服务",
"link": "/zh/xcbi-dev/核心服务模块/bi-cron-"
},
{
"text": "bi-notify 消息通知服务",
"link": "/zh/xcbi-dev/核心服务模块/bi-notify 消息通知服务"
},
{
"text": "bi-notify 消息通知服务",
"link": "/zh/xcbi-dev/核心服务模块/bi-notify-"
},
{
"text": "bi-plan-taoxi 淘系计划服务",
"link": "/zh/xcbi-dev/核心服务模块/bi-plan-taoxi 淘系计划服务"
},
{
"text": "bi-plan-taoxi 淘系计划服务",
"link": "/zh/xcbi-dev/核心服务模块/bi-plan-taoxi-"
},
{
"text": "bi-sys 系统管理服务",
"link": "/zh/xcbi-dev/核心服务模块/bi-sys 系统管理服务"
},
{
"text": "bi-sys 系统管理服务",
"link": "/zh/xcbi-dev/核心服务模块/bi-sys-"
},
{
"text": "bi-tenant 租户管理服务",
"link": "/zh/xcbi-dev/核心服务模块/bi-tenant 租户管理服务"
},
{
"text": "bi-tenant 租户管理服务",
"link": "/zh/xcbi-dev/核心服务模块/bi-tenant-"
},
{
"text": "核心服务模块",
"link": "/zh/xcbi-dev/核心服务模块/核心服务模块"
}
]
},
{
"text": "系统架构",
"collapsed": true,
"items": [
{
"text": "基础设施架构",
"link": "/zh/xcbi-dev/系统架构/基础设施架构"
},
{
"text": "微服务拆分与边界",
"link": "/zh/xcbi-dev/系统架构/微服务拆分与边界"
},
{
"text": "技术栈与选型",
"link": "/zh/xcbi-dev/系统架构/技术栈与选型"
},
{
"text": "数据流设计",
"link": "/zh/xcbi-dev/系统架构/数据流设计"
},
{
"text": "整体架构设计",
"link": "/zh/xcbi-dev/系统架构/整体架构设计"
},
{
"text": "系统架构",
"link": "/zh/xcbi-dev/系统架构/系统架构"
}
]
},
{
"text": "部署运维",
"collapsed": true,
"items": [
{
"text": "CI/CD流水线",
"link": "/zh/xcbi-dev/部署运维/CI_CD流水线"
},
{
"text": "CI/CD流水线",
"link": "/zh/xcbi-dev/部署运维/ci-cd"
},
{
"text": "容器化部署",
"link": "/zh/xcbi-dev/部署运维/容器化部署"
},
{
"text": "故障排除指南",
"link": "/zh/xcbi-dev/部署运维/故障排除指南"
},
{
"text": "数据库备份与恢复",
"link": "/zh/xcbi-dev/部署运维/数据库备份与恢复"
},
{
"text": "监控告警",
"link": "/zh/xcbi-dev/部署运维/监控告警"
},
{
"text": "部署运维",
"link": "/zh/xcbi-dev/部署运维/部署运维"
}
]
},
{
"text": "项目概述",
"collapsed": true,
"items": [
{
"text": "核心功能特性",
"collapsed": true,
"items": [
{
"text": "AI智能体对话系统",
"link": "/zh/xcbi-dev/项目概述/核心功能特性/ai"
},
{
"text": "AI智能体对话系统",
"link": "/zh/xcbi-dev/项目概述/核心功能特性/AI智能体对话系统"
},
{
"text": "仪表板功能",
"link": "/zh/xcbi-dev/项目概述/核心功能特性/仪表板功能"
},
{
"text": "导航系统",
"link": "/zh/xcbi-dev/项目概述/核心功能特性/导航系统"
},
{
"text": "指标管理系统",
"link": "/zh/xcbi-dev/项目概述/核心功能特性/指标管理系统"
},
{
"text": "核心功能特性",
"link": "/zh/xcbi-dev/项目概述/核心功能特性/核心功能特性"
}
]
},
{
"text": "AI辅助开发",
"link": "/zh/xcbi-dev/项目概述/ai"
},
{
"text": "AI辅助开发",
"link": "/zh/xcbi-dev/项目概述/AI辅助开发"
},
{
"text": "开发规范",
"link": "/zh/xcbi-dev/项目概述/开发规范"
},
{
"text": "快速开始指南",
"link": "/zh/xcbi-dev/项目概述/快速开始指南"
},
{
"text": "技术栈概览",
"link": "/zh/xcbi-dev/项目概述/技术栈概览"
},
{
"text": "目录结构说明",
"link": "/zh/xcbi-dev/项目概述/目录结构说明"
},
{
"text": "项目概述",
"link": "/zh/xcbi-dev/项目概述/项目概述"
},
{
"text": "项目简介",
"link": "/zh/xcbi-dev/项目概述/项目简介"
}
]
},
{
"text": "故障排除",
"link": "/zh/xcbi-dev/故障排除"
}
]
}
]
},
"socialLinks": [
{
"icon": "github",
"link": "https://github.com/xfstudio/vitepress-template.git"
}
]
}页面数据
{
"title": "运行时 API 示例",
"description": "",
"frontmatter": {},
"headers": [],
"relativePath": "zh/vitepress/examples/api-examples.md",
"filePath": "zh/vitepress/examples/api-examples.md"
}页面 Frontmatter
{}更多
查看文档以获取 运行时 API 的完整列表。