contract-to-ts README

Contract to TS

MOM平台契约生成前端TS的VS Code扩展插件

功能特性

• 🔧 从MOM平台拉取接口契约并生成TypeScript类型定义
• 📁 支持自定义类型文件保存目录
• 🔄 实时监听文件变化并更新视图
• 🎯 支持接口的增删改查操作
• ⚙️ 支持配置MOM平台访问令牌

使用步骤

1. 配置访问令牌

首次使用需要配置MOM平台的访问令牌：

方法一：通过VS Code设置

1. 打开VS Code设置 (Ctrl+, 或 Cmd+,)
2. 搜索 "contract-to-ts.accessToken"
3. 输入你的MOM平台访问令牌

方法二：通过配置文件 在 settings.json 中添加：

{
  "contract-to-ts.accessToken": "your-access-token-here"
}

2. 初始化项目

1. 切换到插件视图窗口（左侧活动栏的"契约转TS"图标）
2. 点击【初始化类型文件保存目录】按钮
3. 插件会读取项目package.json信息
4. 选择类型文件落地目录

3. 添加接口契约

1. 点击"+"按钮
2. 选择契约所属项目
3. 选择服务号
4. 选择契约版本
5. 选择具体契约

4. 管理接口

契约拉取后会根据项目名称、服务号、契约生成管理视图，支持：

• 更新接口
• 查看接口
• 删除接口

配置说明

注意事项

• 使用前请确保已正确配置accessToken
• 类型文件目录建议选择项目中的src目录
• 插件会自动监听类型文件变化并更新视图