api-postman-collection

Generate and synchronize Postman collection JSON files for Rails API endpoints.

22|6|Updated Mar 11, 2026

Search Tags:#testing #documentation #api #postman #rails #collection

Ready to run

npx skills add https://github.com/igmarin/rails-agent-skills --skill api-postman-collection

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-postman-collection
Source: https://github.com/igmarin/rails-agent-skills/tree/main/api-postman-collection
Command: npx skills add https://github.com/igmarin/rails-agent-skills --skill api-postman-collection

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Rails apps and engines expose HTTP endpoints that need testing and documentation. This skill ensures a Postman collection JSON stays in sync with the API surface by automatically generating or updating the collection when endpoints change.

Core Features & Use Cases

Generate a Postman collection JSON file per app or engine.
Keep endpoint names, descriptions, and variables in English for consistency.
Use across environments by leveraging a base_url variable in the collection.

Quick Start

Automatically generate or update a Postman collection JSON file whenever you add or modify any API endpoint in a Rails app.

Frequently Asked Questions about api-postman-collection

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I keep a Postman collection in sync with Rails API endpoints?▼

You can keep a Postman collection in sync with Rails API endpoints by automatically generating or updating the collection JSON file whenever routes or controller actions change. This ensures the collection reflects the latest API surface.

How do I generate a Postman collection JSON for a Rails engine?▼

Generating a Postman collection JSON for a Rails engine requires maintaining a single collection file per app or engine. The collection is automatically updated when you add or modify API endpoints within that specific engine.

Does the Postman collection support different base URLs for environments?▼

Yes, the Postman collection supports different environments by leveraging a base_url variable pattern. This allows the same generated collection JSON to be used across various deployment environments without altering the endpoint definitions.

Can I use non-English descriptions for API endpoints in the Postman collection?▼

No, you cannot use non-English descriptions. The collection enforces English for all endpoint names and descriptions to maintain consistency across the generated API documentation and testing artifacts.

When should I update my Postman collection for a Rails API?▼

You should update your Postman collection whenever you create or change routes and controller actions in your Rails apps or engines. Automatic synchronization ensures the collection accurately reflects the current API surface.

What is the best way to document Rails API endpoints for testing?▼

The best way to document Rails API endpoints for testing is to automatically generate a Postman collection JSON file that stays synchronized with your routes. This guarantees your testing artifacts always match the latest API surface.