diff --git a/doc/proposals/2025/gsoc/idea_aakarshgopishetty_api_explorer.md b/doc/proposals/2025/gsoc/idea_aakarshgopishetty_api_explorer.md new file mode 100644 index 000000000..89bcc3ad3 --- /dev/null +++ b/doc/proposals/2025/gsoc/idea_aakarshgopishetty_api_explorer.md @@ -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! πŸ”₯ diff --git a/doc/proposals/2025/gsoc/images/overview-api-explorer.png b/doc/proposals/2025/gsoc/images/overview-api-explorer.png new file mode 100644 index 000000000..4f3dab8f9 Binary files /dev/null and b/doc/proposals/2025/gsoc/images/overview-api-explorer.png differ