Skip to content

Commit 1e642ea

Browse files
authored
Merge pull request #719 from aakarshgopishetty/api-explorer-ui
Draft: API Explorer UI Wireframe
2 parents 91d8928 + 3fdc704 commit 1e642ea

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# API Explorer Wireframe
2+
3+
## 📌 Overview
4+
5+
This document presents the wireframe design for the **API Explorer** feature in API Dash. The API Explorer will allow users to:
6+
7+
- **Discover public APIs** across various categories.
8+
- **View API details**, including authentication methods and sample requests.
9+
- **Import APIs into their workspace** for seamless testing.
10+
11+
---
12+
13+
## 🎨 Wireframe Design
14+
15+
The wireframe includes three main sections:
16+
17+
### **1️⃣ Homepage (API Listing Page)**
18+
19+
- **🔍 Search Bar**: Users can search for APIs.
20+
- **📂 Category Filters**: AI, Finance, Weather, etc., to filter APIs.
21+
- **📌 API Cards**: Displays API name, short description, category, and a "View Details" button.
22+
- **➡️ Navigation**: Clicking “View Details” opens the API Details Page.
23+
24+
### **2️⃣ API Details Page**
25+
26+
- **📌 API Name & Description**
27+
- **🔑 Authentication Info** (API key required or not).
28+
- **📂 API Endpoints & Sample Requests**
29+
- **📋 "Copy API Key" Button**
30+
- **📥 "Import API to Workspace" Button**
31+
32+
### **3️⃣ Sidebar (Optional)**
33+
34+
- **📂 Saved APIs List** (Previously imported APIs).
35+
- **⭐ Ratings & Reviews Section** (User feedback if implemented).
36+
37+
---
38+
39+
## 🖼️ Wireframe Link
40+
41+
🔗 **View the wireframe on Excalidraw**:
42+
[API Explorer Wireframe](https://excalidraw.com/#json=71K2EyrjsTEv1HXRMTRqB,iw86qFoQz9coZwkuAcXPUQ)
43+
44+
*(Optional: If you exported an image, add it here)*
45+
![Wireframe Preview](images/overview-api-explorer.png)
46+
47+
---
48+
49+
## 🚀 Next Steps
50+
51+
1. **Review the wireframe and suggest changes (if any).**
52+
2. Once approved, start coding the **frontend UI** (homepage, details page, sidebar).
53+
54+
Looking forward to feedback! 🔥
Loading

0 commit comments

Comments
 (0)