Skip to content

服务

文档中心将所有项目统一收录在 服务 模块下,按 基础设施业务系统 分组。每个服务包含 指南(guide)API 参考(api)

AI 集成(供自动化开发阅读)

文档适用场景
AI 阅读指南任务选读、认证决策、URL 规则
新建资源服务开发新服务时接入 Auth + Gateway
跨服务调用第三方调用 ME56 / Nexus 等已有服务
请求链路与调用说明完整架构总览
基础设施 · 链路说明Auth 换票、Gateway 路由、新服务接入
业务系统 · 链路说明Nexus/ME56 调用、服务间 Feign

基础设施服务见各指南中的 AI 接入;业务系统见 第三方集成

基础设施

链路说明 — 登录换票、API Key 换票、Gateway 路由、新服务接入

服务说明指南API
Unified Auth统一身份认证(OAuth2 / OIDC / API Key)快速开始API 概览
API Gateway统一入口、路由、API Key 换票快速开始API 概览

业务系统

链路说明 — 经 Gateway 调用、Nexus/ME56 模块路径、服务间 Feign

服务说明指南API
Nexus物业服务平台(Spring Boot 4 / Java 21)快速开始API 概览
ME56物流运输管理系统(Spring Boot 2.7 微服务)快速开始API 概览
Fleet车队管理平台(Spring Boot 4 / Java 21)快速开始API 概览

架构关系

完整分步说明见 请求链路与调用说明

线型含义
实线箭头HTTP/HTTPS,经 Gateway 的外部与转发路径
虚线箭头服务间内部 Feign/RPC,不经过 Gateway

外部请求建议统一经 API Gateway;JWT 由 Unified Auth 签发,各业务服务作为 Resource Server 校验。新建服务调用其他业务 API 时,推荐同样经 Gateway 出站(见 链路三)。

目录结构

docs/services/
├── index.md
├── ai/                    # AI 集成总览
├── unified-auth/
├── gateway/
├── nexus/
├── me56/
├── fleet/
└── {新服务}/
    ├── guide/
    │   ├── ai-integration.md          # 基础设施
    │   └── third-party-integration.md # 业务系统
    └── api/

新增服务

  1. 创建 docs/services/{服务名}/guide/api/ 文档。
  2. docs/.vitepress/services.ts 注册(含 category: 'infra' | 'business')。
  3. 内部链接使用 /services/{服务名}/... 前缀。

参考根目录 PROMPT.md 可批量生成文档。

基于 MIT 协议发布