Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft: API Explorer UI Wireframe #719

Merged
merged 4 commits into from
Mar 30, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions doc/proposals/2025/gsoc/idea_aakarshgopishetty_api_explorer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# API Explorer Wireframe

## 📌 Overview

This document presents the wireframe design for the **API Explorer** feature in API Dash. The API Explorer will allow users to:

- **Discover public APIs** across various categories.
- **View API details**, including authentication methods and sample requests.
- **Import APIs into their workspace** for seamless testing.

---

## 🎨 Wireframe Design

The wireframe includes three main sections:

### **1️⃣ Homepage (API Listing Page)**

- **🔍 Search Bar**: Users can search for APIs.
- **📂 Category Filters**: AI, Finance, Weather, etc., to filter APIs.
- **📌 API Cards**: Displays API name, short description, category, and a "View Details" button.
- **➡️ Navigation**: Clicking “View Details” opens the API Details Page.

### **2️⃣ API Details Page**

- **📌 API Name & Description**
- **🔑 Authentication Info** (API key required or not).
- **📂 API Endpoints & Sample Requests**
- **📋 "Copy API Key" Button**
- **📥 "Import API to Workspace" Button**

### **3️⃣ Sidebar (Optional)**

- **📂 Saved APIs List** (Previously imported APIs).
- **⭐ Ratings & Reviews Section** (User feedback if implemented).

---

## 🖼️ Wireframe Link

🔗 **View the wireframe on Excalidraw**:
[API Explorer Wireframe](https://excalidraw.com/#json=71K2EyrjsTEv1HXRMTRqB,iw86qFoQz9coZwkuAcXPUQ)

*(Optional: If you exported an image, add it here)*
![Wireframe Preview](images/overview-api-explorer.png)

---

## 🚀 Next Steps

1. **Review the wireframe and suggest changes (if any).**
2. Once approved, start coding the **frontend UI** (homepage, details page, sidebar).

Looking forward to feedback! 🔥
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.