postman-collection-generator

Files (1)

• SKILL.md

SKILL.md (first lines)

# Postman Collection Generator

Generates a valid, import-ready **Postman Collection v2.1** JSON from:
- Natural language API descriptions
- cURL commands (one or many)
- Mixed input (some endpoints described, some as cURL)

---

## Step 1 — Extract API Information

Parse the user's input and extract for **each endpoint**:

| Field | Source |
|---|---|
| Name | Described name or inferred from path |
| Method | Explicit or inferred (GET for fetches, POST for creates, etc.) |
| URL | Full URL or path; use `{{base_url}}` variable for the host |
| Headers | From cURL `-H` flags or described headers |
| Auth | Bearer token, Basic, API Key, or None |
| Body | From cURL `-d` / `--data` or described payload (JSON, form-data) |
| Query params | From URL `?key=value` or described filters |

If input is ambiguous, make reasonable REST conventions and note assumptions at the end.

---

## Step 2 — Build the Collection JSON

Use this exact v2.1 structure:

```json
{
  "info": {
    "name": "<Collection Name>",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
    "_postman_id": "<generate a UUID v4>",
    "description": "<brief description>"
  },
  "variable": [
    { "key": "base_url", "value": "<extracted base URL or placeholder>", "type": "string" }
  ],
  "auth": <collection-level auth if shared across requests, else null>,
  "item": [ <request items or folders> ]
}
```

### Request item structure:
```json
{
  "name": "Get Users",
  "request": {
    "method": "GET",
    "header": [
      { "key": "Content-Type", "value": "application/json" }
    ],
    "url": {
      "raw": "{{base_url}}/users",
      "host": ["{{base_url}}"],
      "path": ["users"],
      "query": []
    },
    "body": null,
    "auth": null,
    "description": ""
  },
  "response": []
}
```

### Body (when present):
```json
"body": {
  "mode": "raw",
  "raw": "{\n  \"key\": \"value\"\n}",
  "options": { "raw": { "language": "json" } }
}
```

### Grouping:
- Group related endpoints into **folders** using the `item` array nested inside an item with `"name"` but no `"request"` key.
- Use logical grouping: by resource (Users, Orders) or by feature.

---

## Step 3 — Environment Variables

Always extract these into a companion **Postman Environment** file:
- `base_url` — the API host
- Any tokens, API keys, or IDs mentioned

```json
{
  "id": "<uuid>",
  "name": "<Collection Name> Environment",
  "values": [
    { "key": "base_url", "value": "<value>", "enabled": true },
    { "key": "api_key", "value": "", "enabled": true }
  ],
  "_postman_variable_scope": "environment"
}
```

---

## Step 4 — Output

1. Output the **Collection JSON** in a code block labeled `collection.json`
2. Output the **Environment JSON** in a code block labeled `environment.json`
3. List any **assumptions** made (inferred methods, placeholder values, etc.)
4. Provide **import instructions**:
   > Import via Postman → File → Import → paste or upload the JSON

---

## cURL Parsing Reference

| cURL flag | Maps to |
|---|---|

From LambdaTest/agent-skills, MIT.

More from LambdaTest/agent-skills