Skip to content

rutu272705/api-tui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 

Repository files navigation

📟 API-TUI: The Futuristic API Console

API-TUI Mockup

🏢 About

API-TUI is a 🟢 lightweight, terminal-based API testing utility built for developers who value speed, terminal-centric workflows, and high-authority design. Born out of the need for a distraction-free environment to validate endpoints, API-TUI provides a sleek ⚫ "command center" interface that eliminates the bloat of traditional GUI-based API clients.

It leverages the power of the Textual framework to deliver a responsive, keyboard-driven experience with a 🔘 "Furistic" (Futuristic Heuristics) aesthetic that makes your terminal feel like a high-end HUD.


🎨 Design System

API-TUI is built on a precise color palette optimized for clarity and high-authority terminal aesthetics:

Tone Hex Code Description
🟢 System Success #00ff9c Neon Green - Primary UI and Text
⚫ Deep Space #000000 Pure Black - Main Background
🔘 Obsidian #050505 Deep Grey - Panel Backgrounds
🔵 Teal Depths #001f1f Dark Teal - Interactive Accents

✨ Features

  • 🚀 Rapid Testing: Send GET and POST requests in 🟢 seconds without leaving your CLI.
  • 🎨 Furistic UI: A high-contrast ⚫ neon-green aesthetic designed for maximum focus and low eye strain.
  • 📋 Header Support: Easily add custom headers using a simple key:value syntax.
  • 📦 JSON Body: Full support for JSON payloads in POST requests with real-time error handling.
  • ⚡ Split-Panel Layout: Visual separation between your 🔘 request configuration and the server's response.
  • ⌨️ Keyboard Centric: Fully navigable via keyboard for maximum 🔵 developer velocity.

🛠️ Installation

Ensure you have Python 3.8+ installed, then install the dependencies via terminal:

pip install textual requests

🚀 Quick Start

To launch the 🟢 API-TUI console, run:

python main.py

📖 Usage Guide

  1. 🟢 Select Method: Toggle between GET and POST.
  2. URL: Enter the target API endpoint.
  3. 🔘 Headers: Add headers as Key:Value. Multiple headers can be separated by commas.
  4. 🔵 Body: For POST requests, enter valid JSON into the body field.
  5. 🟢 Send: Click "Send Request" or press Enter to see the live response.

🧭 Design Principles

This project follows the Furistics design framework. For a deep dive into the UX heuristics and aesthetic choices, see 🧪 FURISTICS.md.


📄 License

📜 MIT License. See LICENSE for more details. (Coming soon)

About

A sleek, futuristic Terminal UI (TUI) for rapid API testing. Built with Python and Textual, following the "Furistics" design framework for a premium, distraction-free developer experience.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages