Rest To Postman

🚀 REST-to-Postman MCP

REST APIコード（例：NestJSコントローラー、FastAPI/Flaskエンドポイント）をPostmanコレクションと環境に変換するモデルコンテキストプロトコル（MCP）サーバーです。このツールは開発者がREST APIエンドポイントと環境設定をPostmanと自動的に同期するのを支援します。

🚀 クイックスタート

REST-to-Postman MCPは、REST APIコードをPostmanコレクションと環境に変換するための便利なツールです。以下の手順に従って、簡単に始めることができます。

✨ 主な機能

• REST APIエンドポイントをPostmanコレクションに変換します。
• 環境変数をPostman環境に同期します。
• 複数の認証方法（例：Bearerトークン）をサポートします。
• 新しいエンドポイントを既存のコレクションにスマートにマージします。
• 機密性の高い環境変数を自動的に処理します。
• RESTとリアルタイムフィードバックの2つのモードをサポートします。

📦 インストール

npxを使用して実行

npx rest-to-postman-mcp

Smitheryを使用してインストール

1. smithery.aiにアクセスします。
2. 指示に従って設定とデプロイを行います。

💻 使用例

サーバーの起動

# デフォルトモードで起動
npx rest-to-postman-mcp

# リアルタイムフィードバックモードで起動
npx rest-to-postman-mcp --sSE

設定ファイルの作成

.envファイルを作成します：

POSTMAN_API_KEY=あなたのPostman APIキー
POSTMAN_ACTIVE_WORKSPACE_ID=あなたのPostmanアクティブワークスペースID

基本的な使用法

以下は使用例です：

入力コード：

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トークン設定が含まれます。

🔧 ローカル開発

リポジトリのクローン

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 src/mcp.ts

# リアルタイムフィードバックモードで実行
bun run src/mcp.ts --sSE

プロジェクトのビルド

bun run build

ビルドが完了すると、出力ファイルはdistディレクトリに配置されます。

📚 ドキュメント

スクリプトコマンド

• bun run build - プロジェクトをビルドします。
• bun run dev - 開発モードでサーバーを実行します。
• bun run startSSE - リアルタイムフィードバックモードでサーバーを起動します。

貢献

貢献を歓迎します！自由にPull Requestを提出してください。

📄 ライセンス

このプロジェクトはMITライセンスの下で公開されています。詳細はLICENSEファイルを参照してください。