接口设计管理
AngusTester接口设计管理
模块实现OpenAPI规范全生命周期管理,支持设计创建、导入编辑到服务生成全流程。
一、设计创建与导入
1. 创建新设计
操作说明:初始化OpenAPI规范框架
操作步骤:
接口 → 设计
点击「添加设计」- 填写基本信息:
- 名称(格式:
[系统]_API设计_V1.0
) - OpenAPI规范版本(2.0/3.0.x)
- 名称(格式:
- 点击「保存」生成设计草稿
2. 导入现有设计
操作说明:复用外部API规范文件
操作步骤:
- 文件导入:
- 点击「导入设计」
- 上传Swagger/OpenAPI文件(JSON/YAML)
- 服务导入:
- 点击「导入服务」
- 选择已有服务自动生成设计
❗ 导入后需校验规范完整性
二、规范设计与编辑
1. 设计API规范
操作说明:编辑OpenAPI详细定义
操作步骤:
设计列表
点击目标设计「设计」- 在编辑器配置:
- 基础信息(主机/协议/全局参数)
- 路径定义(RESTful端点)
- 组件管理(Schema/响应模板)
- 点击「保存草稿」暂存
2. 修改设计内容
操作说明:更新API定义细节
操作步骤:
设计编辑器
定位目标节点- 修改字段:
- 端点路径增删
- 请求参数调整
- 响应示例更新
⚠️ 重大变更需创建新版本
3. 克隆设计规范
操作说明:快速创建迭代版本
操作步骤:
设计列表
点击「克隆」- 自动生成:
- 副本名称(
原名称-Copy
) - 保留全部规范定义
需手动升级版本号
- 副本名称(
三、设计发布与服务生成
1. 发布设计版本
操作说明:冻结设计规范状态
操作步骤:
设计编辑器
点击「发布设计」- 填写版本变更说明
- 状态变更为"已发布"
❗ 发布后禁止直接修改
2. 生成接口服务
操作说明:创建可执行API服务
操作步骤:
设计列表
选择已发布设计- 点击「生成服务」
- 系统自动:
- 创建API服务分组
- 生成全部接口端点
- 同步参数校验规则
✅ 在接口→服务
中查看
3. 设计规范导出
操作说明:共享API设计文档
操作步骤:
设计列表
点击「导出」- 选择格式:
- OpenAPI JSON
- Swagger YAML
四、维护管理操作
1. 设计版本升级 TODO
操作说明:管理多版本API设计
操作步骤:
设计列表
点击历史版本- 选择「升级版本」
- 创建新设计副本
- 修改后重新发布
❗ 需维护版本兼容性
2. 删除设计
操作说明:清理废弃API设计
操作步骤:
设计列表
选中目标- 点击「删除」
- 二次确认操作
⚠️ 关联服务不受影响