Rest To Postman

🚀 REST-to-Postman MCP

一个模型上下文协议（MCP）服务器，可将REST API代码（如NestJS控制器、FastAPI/Flask端点）转换为Postman集合和环境。该工具助力开发者自动同步其REST API端点和环境配置至Postman，提升开发效率。

🚀 快速开始

此工具提供了便捷的使用方式，你可以通过npx快速运行，也能通过Smithery进行安装部署。

通过npx运行

npx rest-to-postman-mcp

通过Smithery安装

1. 访问smithery.ai
2. 依照页面指示完成设置和部署。

✨ 主要特性

• 端点转换：将REST API端点转换为Postman集合。
• 环境同步：同步环境变量到Postman环境。
• 多认证支持：支持多种身份验证方法（如Bearer令牌）。
• 智能合并：智能合并新端点到现有集合中。
• 敏感变量处理：自动处理敏感的环境变量。
• 双模式支持：支持REST和实时反馈两种模式。

📦 安装指南

克隆仓库

git clone https://github.com/runninghare/rest-to-postman.git
cd rest-to-postman

安装依赖

bun install

创建配置文件

创建一个.env文件：

POSTMAN_API_KEY=你的Postman API密钥
POSTMAN_ACTIVE_WORKSPACE_ID=你的Postman活动工作区ID

构建项目

bun run build

构建完成后，输出文件将存于dist目录。

💻 使用示例

基础用法

启动服务器

# 在默认模式下启动
npx rest-to-postman-mcp

# 在实时反馈模式下启动
npx rest-to-postman-mcp --sSE

创建配置文件

创建一个.env文件：

POSTMAN_API_KEY=你的Postman API密钥
POSTMAN_ACTIVE_WORKSPACE_ID=你的Postman活动工作区ID

高级用法

以下是一个使用示例，展示如何将NestJS控制器代码转换为Postman集合。

输入代码：

import { type } from 'class-transformer'
import {
  Body,
  Controller,
  Delete,
  Get,
  HttpCode,
  Param,
  Post,
  Put,
} from 'nestjs'

@Controller('users')
export class UsersController {
  @Post()
  @HttpCode(201)
  async createUser(@Body() user: UserDto) {
    return { message: '用户创建成功' }
  }

  @Get()
  findAll() {
    return { message: '获取所有用户' }
  }

  @Get(':id')
  findOne(@Param('id') id: string) {
    return { message: '获取单个用户', id }
  }

  @Put(':id')
  update(@Param('id') id: string, @Body() user: UserDto) {
    return { message: '更新用户', id }
  }

  @Delete(':id')
  remove(@Param('id') id: string) {
    return { message: '删除用户', id }
  }
}

自动生成的Postman集合： 所有从UsersController定义的端点都会自动生成，并且包含Bearer令牌设置。

📚 详细文档

脚本命令

• bun run build - 构建项目
• bun run dev - 以开发模式运行服务器
• bun run startSSE - 以实时反馈模式启动服务器

本地开发

运行开发模式

# 在默认模式下运行
bun run src/mcp.ts

# 在实时反馈模式下运行
bun run src/mcp.ts --sSE

📄 许可证

此项目采用MIT许可证，详情请查阅LICENSE文件。

贡献

欢迎大家积极贡献！你可以随时提交Pull Request。