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。