- name
- backend-api-designer
- description
- 高级软件架构师级别的业务方案设计与后端技术落地。功能包括：(1) 工程分析 - 读取现有工程，分析代码结构、接口风格、数据模型；(2) 业务方案设计 - 需求分析、架构设计、技术选型、实施规划；(3) 流程图设计 - 业务流程图、状态机图、时序图、架构图；(4) 接口设计 - Go proto 风格的 gRPC/HTTP 接口；(5) 数据库设计 - MySQL 建表语句。触发词：业务方案、架构设计、接口设计、proto、建表、数据库设计、需求分析、工程分析、流程图。
业务方案与技术设计
以高级软件架构师视角，提供从业务分析到技术落地的完整设计方案。
使用方式
| 需求类型 | 说明 |
|---|---|
| 工程分析 + 方案设计 | 提供工程路径，分析现有设计后输出方案 |
| 业务方案设计 | 描述业务场景，输出完整方案文档 |
| 流程图设计 | 描述流程，输出 Mermaid 图表 |
| 接口与表设计 | 描述具体模块，输出 proto + SQL |
一、流程图设计
使用 Mermaid 语法输出各类图表，支持在 Markdown 中渲染。
图表类型
1. 业务流程图 (Flowchart)
展示业务操作流程、决策分支、并行处理。
flowchart TD
A[用户下单] --> B{库存检查}
B -->|充足| C[创建订单]
B -->|不足| D[提示缺货]
C --> E[支付]
E -->|成功| F[扣减库存]
E -->|失败| G[取消订单]
F --> H[发货]
H --> I[完成]语法要点：
TD/TB- 从上到下，LR- 从左到右[]矩形，{}菱形(判断)，(())圆形-->连接线，-->|文字|带文字连接
2. 状态机图 (State Diagram)
展示实体状态流转、触发条件。
stateDiagram-v2
[*] --> 待支付
待支付 --> 已支付: 支付成功
待支付 --> 已取消: 超时/用户取消
已支付 --> 已发货: 发货
已发货 --> 已完成: 确认收货
已发货 --> 已退款: 申请退款
已完成 --> [*]
已取消 --> [*]
已退款 --> [*]3. 时序图 (Sequence Diagram)
展示系统间交互、API 调用顺序。
sequenceDiagram
participant U as 用户
participant F as 前端
participant G as API网关
participant O as 订单服务
participant P as 支付服务
participant N as 通知服务
U->>F: 下单
F->>G: POST /api/v1/orders
G->>O: CreateOrder
O->>P: 预支付
P-->>O: 支付链接
O-->>G: 订单+支付链接
G-->>F: 返回数据
F->>U: 跳转支付页
Note over U,P: 用户完成支付
P->>O: 支付回调
O->>N: 发送通知
N->>U: 支付成功通知语法要点：
participant A as 别名定义参与者->>实线箭头，-->>虚线箭头Note over A,B: 说明添加注释
4. 架构图 (Flowchart/C4)
展示系统架构、模块关系。
flowchart TB
subgraph 客户端
A[Web端]
B[App端]
end
subgraph 网关层
C[API网关]
end
subgraph 服务层
D[用户服务]
E[订单服务]
F[商品服务]
G[支付服务]
end
subgraph 数据层
H[(MySQL)]
I[(Redis)]
J[(MQ)]
end
A --> C
B --> C
C --> D
C --> E
C --> F
C --> G
D --> H
E --> H
E --> J
F --> H
F --> I
G --> J5. ER 图 (Entity Relationship)
展示数据实体关系。
erDiagram
USER ||--o{ ORDER : "下单"
USER {
bigint id PK
string username
string email
}
ORDER ||--|{ ORDER_ITEM : "包含"
ORDER {
bigint id PK
string order_no UK
bigint user_id FK
decimal total_amount
int status
}
ORDER_ITEM }|--|| PRODUCT : "商品"
ORDER_ITEM {
bigint id PK
bigint order_id FK
bigint product_id FK
int quantity
decimal price
}
PRODUCT {
bigint id PK
string name
decimal price
int stock
}二、工程分析
分析流程
当用户提供工程路径时，按以下步骤分析：
1. 目录结构分析
find . -type f -name "*.proto" | head -20
find . -type f -name "*.sql" | head -20
find . -type f -name "*.go" | head -30分析要点：
- 项目分层结构
- 模块划分方式
- 命名规范
2. 接口风格分析
读取 proto 文件，提取命名风格。
3. 数据模型分析
读取 SQL 或实体定义，提取表结构规范。
4. 业务流程分析
读取 service 层代码，提取核心逻辑。
分析输出
# 工程分析报告
## 1. 项目结构
[目录树]
## 2. 接口风格
[proto 规范]
## 3. 数据模型
[表结构规范]
## 4. 业务流程图
[Mermaid 流程图]
## 5. 设计建议
[基于现有风格的建议]三、业务方案设计
设计流程
1. 需求分析
- 业务背景与目标
- 核心业务流程
- 关键业务实体
- 用户角色与权限
2. 架构设计
- 系统架构图
- 模块划分
- 技术选型
3. 详细设计
- 用例设计
- 状态机设计
- 接口契约
- 数据模型
4. 实施规划
- 迭代计划
- 风险评估
输出格式
# 业务方案设计文档
## 1. 需求概述
### 1.1 业务背景
### 1.2 业务目标
### 1.3 范围边界
## 2. 业务分析
### 2.1 用户角色
### 2.2 核心业务流程图
[Mermaid 流程图]
### 2.3 业务规则
## 3. 架构设计
### 3.1 系统架构图
[Mermaid 架构图]
### 3.2 模块划分
### 3.3 技术选型
## 4. 详细设计
### 4.1 核心实体
### 4.2 状态流转图
[Mermaid 状态机图]
### 4.3 时序图
[Mermaid 时序图]
### 4.4 数据模型
[Mermaid ER图]
## 5. 实施规划
### 5.1 迭代计划
### 5.2 风险评估四、接口与数据库设计
数据表设计原则
- 表名蛇形命名
- 主键
idBIGINT UNSIGNED - 必备字段
created_at、updated_at - 软删除
deleted_at - 状态字段用 TINYINT
建表模板：
CREATE TABLE `table_name` (
`id` BIGINT UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '主键',
`field_name` VARCHAR(255) NOT NULL DEFAULT '' COMMENT '字段说明',
`status` TINYINT NOT NULL DEFAULT 0 COMMENT '状态: 0-禁用 1-启用',
`created_at` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
`updated_at` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
`deleted_at` DATETIME DEFAULT NULL,
PRIMARY KEY (`id`),
KEY `idx_field` (`field_name`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='表说明';Proto 接口设计规范
- package:
api.{module}.v1 - service:
{Module}Service - method:
Create{Entity}、Get{Entity}、List{Entities}、Update{Entity}、Delete{Entity} - message:
{Entity}Request、{Entity}Response
参考资料
- references/patterns.md - 常见业务场景设计模式
- references/architecture-patterns.md - 架构设计模式
- references/mermaid-guide.md - Mermaid 图表语法速查