Back to Documentation

🚀 MicroRapid Quick Start Guide

⚡ The 30-Second Version

Turn any API into an executable CLI. One command. Instant power.

Supports Swagger 2.0, OpenAPI 3.0, and OpenAPI 3.1 specifications

npm install -g mrapids
mrapids init petstore --from-url https://petstore3.swagger.io/api/v3/openapi.json
mrapids run addPet -i

🎬 See it in Action

🎯 Why You’re Here

📚 The Problem

5000-line API specs (Swagger/OpenAPI) that nobody reads

🔍 The Pain

300+ endpoints you don't know exist

🚀 The Solution

One CLI that makes any API instantly usable

⚡ Installation

Quick Install

npm install -g mrapids

🍎 macOS

npm install -g mrapids

🐧 Linux

npm install -g mrapids

🪟 Windows

npm install -g mrapids

🏃 Your First API in 60 Seconds

⚡ Works with any OpenAPI spec (Swagger 2.0, OpenAPI 3.0, 3.1)

Step 1: Initialize (3 seconds)

mrapids init petstore --from-url https://petstore3.swagger.io/api/v3/openapi.json

What happens:

  • ✨ Downloads the API specification
  • 🔍 Discovers all operations automatically
  • 📁 Creates project structure
  • 🚀 Ready to use immediately

Step 2: Discover (5 seconds)

# Find what you need
mrapids list --filter pet

# Output:
addPet       POST    /pet
findPetsByStatus  GET     /pet/findByStatus
updatePet    PUT     /pet
deletePet    DELETE  /pet/{petId}
→ 8 operations found

Step 3: Execute (10 seconds)

# Interactive mode generates perfect templates
mrapids run addPet -i

# Creates a JSON template with all parameters
# Edit it, then run:
mrapids run addPet --file pet.json

✅ Pet added: {"id": 12345, "name": "Fluffy", "status": "available"}
🎉 Success! You just integrated the Pet Store API in 18 seconds. No documentation needed.

🧙 Power Features

🔍 Smart Discovery

Find any operation instantly

mrapids list --filter user --method POST

📝 Interactive Templates

Never forget parameters

mrapids run ComplexOp -i

🔄 Team Workflows

Share via Git

mrapids collection run tests

🔐 Secure Auth

Environment-based

export API_KEY="sk_..."
mrapids run SecureOp

🔍 Preview Mode

See before sending

mrapids run DeleteUser --dry-run

🤖 AI Ready

MCP Agent compatible

mrapids agent start

💪 Real-World Workflows

Testing API Workflows

# pet-workflow.yaml
name: Pet Store Workflow
requests:
  - name: Add Pet
    operation: addPet
    save_as: pet
    
  - name: Find Pet
    operation: getPetById
    params:
      petId: "{{pet.id}}"
# Run the entire flow
mrapids collection run pet-workflow
✅ All operations succeeded in 234ms

Bulk Operations

# Process CSV of pets
cat pets.csv | while read name status; do
  mrapids run addPet --param name="$name" --param status="$status"
done

🏆 Success Stories

"Reduced API integration from 2 weeks to 2 hours"

— Engineering Lead, FinTech Startup

"Deleted 500 Postman collections. Everything in Git now."

— DevOps Team Lead

"Works with our legacy Swagger 2.0 specs and new OpenAPI 3.1"

— API Platform Team

📊 Quick Reference

What You Want Command Time
Initialize API (any spec format) mrapids init api-name --from-url url 3s
Find operations mrapids list --filter term 1s
See parameters mrapids show operation 1s
Generate template mrapids run operation -i 2s
Execute request mrapids run operation --file file 100ms
Preview request --dry-run 0s
Show as curl --as-curl 0s

🚦 Try These Right Now

1️⃣ GitHub API (OpenAPI 3.0)

mrapids init github \
  --from-url https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.json
mrapids list --filter repo
mrapids run repos/get \
  --param owner=facebook \
  --param repo=react

2️⃣ JSONPlaceholder (Swagger 2.0)

mrapids init jsonplaceholder \
  --from-url https://jsonplaceholder.typicode.com/swagger.json
mrapids list --filter posts
mrapids run getPosts

3️⃣ Your API (Any Format)

# Works with Swagger 2.0, OpenAPI 3.0/3.1
mrapids init my-api \
  --from-url localhost:3000/swagger.json
mrapids doctor
mrapids run healthCheck

🎯 Your Learning Path

📘 Level 1: Today

  • ✓ Install mrapids
  • ✓ Initialize first API
  • ✓ Run 5 operations
  • ✓ Save a collection

📗 Level 2: This Week

  • Share collections via Git
  • Set up environments
  • Create test suites
  • Add to CI/CD

📙 Level 3: Next Week

  • Install MCP agent
  • Connect to AI
  • Set up policies
  • Automate workflows

📋 Supported API Specifications

🟡 Swagger 2.0

Classic format, widely supported

mrapids init api --from-url \
  https://example.com/swagger.json

🟢 OpenAPI 3.0

Modern standard, rich features

mrapids init api --from-url \
  https://example.com/openapi.yaml

🔵 OpenAPI 3.1

Latest version, JSON Schema compatible

mrapids init api --from-url \
  https://example.com/openapi.json

🔧 Universal Support

mrapids automatically detects and handles all major API specification formats - just provide the URL and it works.

💡 Pro Tips

Speed Run Everything

# Alias for speed
alias mr='mrapids'
alias mrl='mrapids list --filter'
alias mrr='mrapids run'

Initialize and run in one line


mrapids init api —from-url url && mrapids run GetStatus


Test safely in production


mrapids run DeleteEverything —env prod —dry-run

🆘 Instant Troubleshooting

Problem Solution
"Command not found" npm install -g mrapids
"Invalid spec" mrapids doctor --fix
"Auth failed" export API_KEY=your_key
"Can't find operation" mrapids list

🌟 Join the Community

GitHub

github.com/microrapids/cli

⭐ npm star

Support

support@microrapid.io

💬 Get help

Documentation

microrapid.io/docs

📚 Deep dive

🚀 Ready to Transform Your API Workflow?

npm install -g mrapids && mrapids --help

No signups. No credit cards. Just instant API power.

Built with ❤️ by developers who were tired of slow APIs

</div>