postman-claude-skill

🥈Silver

Automate API testing and monitoring with Postman using Claude. Operations teams benefit from AI-driven test case generation, execution, and reporting. Connects to Postman collections and environments for automated workflows.

2250Updated 2mo ago

Intermediate30min to implementautomation

Saves ~40 min per use

Quick InstallView Source

git clone https://github.com/SterlingChin/postman-claude-skill.git

Works with:

Claude

Overview

About This Skill

The Postman Claude Skill integrates Postman's API testing platform with Claude to automate API workflows across the entire lifecycle—discovery, design, build, test, security, deployment, monitoring, and documentation. Claude can execute collection tests with Newman integration, parse detailed pass/fail results, create and manage monitors for continuous API monitoring, validate API schemas against OpenAPI and Swagger standards, manage collections and environments, configure authentication and security settings, and create mock servers for prototyping. Teams use this skill to discover workspace resources, compare API versions, identify schema changes, assess documentation quality, and analyze monitor analytics including success rates and response times.

How to Use

[{"step":"Install Postman CLI and authenticate. Run `npm install -g postman-cli` and log in with your Postman account using `postman login`.","tip":"Ensure you have the correct Postman API key with permissions to access collections and environments."},{"step":"Import or create a Postman collection for your API. Use the prompt template to generate a collection with test cases tailored to your endpoints and requirements.","tip":"For existing collections, add test scripts to validate response fields, status codes, and edge cases. Use Postman's 'Tests' tab to write assertions."},{"step":"Set up Postman environments for different stages (e.g., dev, staging, prod). Use variables like `{{base_url}}` and `{{api_key}}` to make the collection reusable across environments.","tip":"Test environment-specific configurations (e.g., different base URLs or authentication tokens) to ensure the collection works in all contexts."},{"step":"Run the collection locally or in CI/CD. Use `postman collection run <collection_uid> --environment <environment_uid>` to execute tests and generate reports.","tip":"Schedule runs in Postman's monitoring feature or integrate with tools like GitHub Actions, Jenkins, or CircleCI for continuous testing."},{"step":"Review test results and set up alerts for failures. Use Postman's built-in reporting or export results to tools like Slack, Datadog, or email for visibility.","tip":"For critical APIs, configure webhooks to notify your team immediately when tests fail or performance degrades."}]

Use Cases

Run API test collections with environment variables and analyze pass/fail results

Create and monitor continuous API monitoring with analytics and run history

Validate API schemas against OpenAPI 3.0 and Swagger standards

Manage Postman collections, environments, and mock servers programmatically

Setup & Installation

Quick Install

No install command available. Check the GitHub repository for manual installation instructions.

Alternative Install (Git Clone)

git clone https://github.com/SterlingChin/postman-claude-skill

Requirements

Claude Code or compatible AI agent
Works with: Claude

Quick Start Guide

Install the Skill

Copy the install command above and run it in your terminal.

Open Your AI Agent

Launch Claude Code, Cursor, or your preferred AI coding agent.

Try It Out

Use the prompt template or examples below to test the skill.

Customize

Adapt the skill to your specific use case and workflow.

Usage Examples

Prompt Template

Generate a Postman collection for [API_SERVICE] that tests [ENDPOINTS] with the following requirements: [REQUIREMENTS]. Include test cases for [SCENARIOS] and ensure the collection validates [RESPONSE_FIELDS]. Export the collection as a JSON file and provide a summary of the test coverage. Use Postman CLI to run the collection and report any failures.

Example Output

```json
{
  "info": {
    "name": "E-Commerce API Test Suite",
    "description": "Comprehensive test suite for the AcmeCorp e-commerce API v2.1",
    "version": "1.0.0"
  },
  "item": [
    {
      "name": "GET /products",
      "request": {
        "method": "GET",
        "header": [],
        "url": {
          "raw": "https://api.acmecorp.com/v2.1/products?category=electronics&limit=10",
          "protocol": "https",
          "host": ["api", "acmecorp", "com"],
          "path": ["v2.1", "products"],
          "query": [
            {
              "key": "category",
              "value": "electronics"
            },
            {
              "key": "limit",
              "value": "10"
            }
          ]
        }
      },
      "response": []
    },
    {
      "name": "POST /cart - Add Item",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Authorization",
            "value": "Bearer {{api_key}}"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\"product_id\": \"prod_12345\", \"quantity\": 2}"
        },
        "url": {
          "raw": "https://api.acmecorp.com/v2.1/cart",
          "protocol": "https",
          "host": ["api", "acmecorp", "com"],
          "path": ["v2.1", "cart"]
        }
      },
      "event": [
        {
          "listen": "test",
          "script": {
            "exec": [
              "pm.test(\"Status code is 201\", function() {",
              "    pm.response.to.have.status(201);",
              "});",
              "",
              "pm.test(\"Response has product_id\", function() {",
              "    const jsonData = pm.response.json();",
              "    pm.expect(jsonData.product_id).to.eql(\"prod_12345\");",
              "});",
              "",
              "pm.test(\"Quantity is updated\", function() {",
              "    const jsonData = pm.response.json();",
              "    pm.expect(jsonData.quantity).to.eql(2);",
              "});"
            ],
            "type": "text/javascript"
          }
        }
      ]
    },
    {
      "name": "DELETE /cart/{item_id} - Remove Item",
      "request": {
        "method": "DELETE",
        "header": [
          {
            "key": "Authorization",
            "value": "Bearer {{api_key}}"
          }
        ],
        "url": {
          "raw": "https://api.acmecorp.com/v2.1/cart/itm_67890",
          "protocol": "https",
          "host": ["api", "acmecorp", "com"],
          "path": ["v2.1", "cart", "itm_67890"]
        }
      },
      "event": [
        {
          "listen": "test",
          "script": {
            "exec": [
              "pm.test(\"Status code is 204\", function() {",
              "    pm.response.to.have.status(204);",
              "});"
            ],
            "type": "text/javascript"
          }
        }
      ]
    }
  ]
}
```

### Test Coverage Summary
This Postman collection includes **15 test cases** covering the following scenarios for the AcmeCorp e-commerce API:

1. **Product Catalog Tests** (5 cases):
   - Validates pagination for `/products` (tested with `limit=10`, `limit=50`, and `offset=20`).
   - Ensures filtering by category (`electronics`, `clothing`) returns correct results.
   - Checks response structure for product details (id, name, price, stock).

2. **Cart Management Tests** (6 cases):
   - Tests adding items to cart with valid/invalid product IDs.
   - Validates quantity updates and edge cases (e.g., adding more than available stock).
   - Ensures removal of items works as expected.
   - Checks cart state persistence across sessions.

3. **Order Processing Tests** (4 cases):
   - Validates order creation with valid/invalid payment methods.
   - Tests order status transitions (pending → confirmed → shipped).
   - Ensures order cancellation works and updates inventory.

**Key Validations:**
- All responses include required fields (`id`, `status`, `timestamp`).
- Error responses return appropriate HTTP status codes (4xx for client errors, 5xx for server errors).
- Rate limiting is tested (429 responses for 100 requests/minute).

**Postman CLI Execution Results:**
```
✓ 15/15 tests passed
✓ No failures detected
✓ All assertions validated
```

The collection is ready for integration into your CI/CD pipeline or scheduled monitoring workflows.