# Generate Postman Collection

> A Claude skill from thoughtbot/generate-postman-collection.

- **Type:** Skill
- **Install:** `agentstack add skill-thoughtbot-generate-postman-collection-generate-postman-collection`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [thoughtbot](https://agentstack.voostack.com/s/thoughtbot)
- **Installs:** 0
- **Category:** [Agent Skills](https://agentstack.voostack.com/c/agent-skills)
- **Latest version:** 0.1.0
- **License:** MIT
- **Upstream author:** [thoughtbot](https://github.com/thoughtbot)
- **Source:** https://github.com/thoughtbot/generate-postman-collection

## Install

```sh
agentstack add skill-thoughtbot-generate-postman-collection-generate-postman-collection
```

Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent.

## About

# Generate Postman Collection

Automatically generate or update the Postman API collection by analyzing the Rails application routes, controllers, and test specs.

## Task Instructions

You are tasked with generating or updating the Postman collection file `postman_collection.json` based on the current state of the Rails API.

Follow these steps:

If there is no existing Postman collection file `postman_collection.json`, 
skip to Step 2.

1. **Check for API-related changes first** (to avoid unnecessary work):
   - Use `git diff` to check if there are any changes to API-related files compared to the main branch
   - Check these paths: `config/routes.rb`, `app/controllers/api/`, `spec/requests/api/`
   - Also check for staged and unstaged changes in the current working directory
   - If NO changes are found in any of these locations, output "No API changes detected - skipping Postman collection update"
   - If changes ARE found, continue to step 2

2. **Read the Rails routes** from `config/routes.rb` to identify all API endpoints

3. **Analyze each API controller** in `app/controllers/api/` to understand:
   - Request parameters (required and optional)
   - Request body structure
   - Response format
   - Authentication requirements
   - Status codes returned

4. **Review RSpec test files** in `spec/requests/api/v1/` to extract:
   - Example request bodies
   - Example responses
   - Valid parameter values
   - Edge cases and validation rules

5. **Generate or update the Postman collection** with:
   - All API endpoints organized in logical folders
   - Complete request examples with proper HTTP methods
   - Request body examples in JSON format
   - Query parameters where applicable
   - Headers (especially Authorization header for authenticated endpoints)
   - Example responses
   - Clear descriptions for each endpoint
   - Variables for `{{base_url}}` and `{{api_token}}`
   - Test scripts that auto-save the API token after successful login

6. **Maintain the existing structure**:
   - Keep the same collection name: "postman_collection"
   - Preserve the variables: `base_url` and `api_token`
   - Maintain folder organization
   - Keep the login test script that auto-saves the token

7. **Ensure completeness**:
   - Every route in `config/routes.rb` should have a corresponding request
   - Each request should have accurate parameters and examples
   - Descriptions should explain what each endpoint does
   - Authentication requirements should be clearly indicated

8. **Write the updated collection** to `postman_collection.json`

## Important Notes

- Use the RSpec tests as the source of truth for request/response examples
- Maintain proper Postman collection v2.1 format
- Ensure all JSON is properly formatted and valid

## Output

After completing the update, provide a summary of:

- Number of endpoints documented
- Any new endpoints added
- Any endpoints removed or modified
- Any issues or ambiguities found

## Completion

If changes have been made notify the user to commit them.

## Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

- **Author:** [thoughtbot](https://github.com/thoughtbot)
- **Source:** [thoughtbot/generate-postman-collection](https://github.com/thoughtbot/generate-postman-collection)
- **License:** MIT

Install and usage instructions live in the source repository linked above.

## Pricing

- **Free** — Free

## Security capabilities

Automated source analysis of v0.1.0 — what this tool can access:

- **Network access:** no
- **Filesystem access:** no
- **Shell / process execution:** no
- **Environment & secrets:** no
- **Dynamic code execution:** no

*"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.*


## Versions

- **0.1.0** — security scan: passed — Imported from the upstream source.

## Links

- Listing page: https://agentstack.voostack.com/l/skill-thoughtbot-generate-postman-collection-generate-postman-collection
- Seller: https://agentstack.voostack.com/s/thoughtbot
- Browse the marketplace: https://agentstack.voostack.com/browse

---
Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.