|
| 1 | +### Initial Idea Submission |
| 2 | + |
| 3 | +* Full Name: Chaitanya Shivram Parab |
| 4 | +* Email: [cparab02@gmail.com](mailto:cparab02@gmail.com) |
| 5 | +* [Github](https://github.com/Chaitanya-Parab) |
| 6 | +* [LinkedIn](https://www.linkedin.com/in/chaitanya-parab/) |
| 7 | +* University name: Sindhudurg Shikshan Prasarak Mandal's College of Engineering, Kankavli |
| 8 | +* Degree: Bachelor's of Engineering |
| 9 | +* Major: Computer Science |
| 10 | +* Year: 3rd year |
| 11 | +* Expected graduation date: 2027 |
| 12 | + |
| 13 | +Project Title: API Explorer |
| 14 | +Relevant issues: (https://github.com/foss42/apidash/issues/619) |
| 15 | + |
| 16 | +### Idea description: |
| 17 | + |
| 18 | +**Project Description** |
| 19 | + |
| 20 | +This project aims to improve the usability of API Dash by introducing a curated API Marketplace backed by an automated backend pipeline. |
| 21 | + |
| 22 | +The system will allow developers to: |
| 23 | + 1.Discover APIs across multiple domains (AI, finance, weather, etc.) |
| 24 | + 2.Search and filter APIs based on category, complexity and ratings. |
| 25 | + |
| 26 | +The backend automation pipeline will: |
| 27 | + 1.Parse OpenAPI specifications and HTML documentation. |
| 28 | + 2.Extract and normalize API data. |
| 29 | + 3.Automatically categorize and tag APIs. |
| 30 | + 4.Generate ready-to-use request templates. |
| 31 | +This reduces manual effort and enables one-click API testing, significantly improving developer onboarding and productivity. |
| 32 | + |
| 33 | +**Project Goals** |
| 34 | + |
| 35 | +1.Primary Goal |
| 36 | + a. To build automated pipeline for API's with OpenAPI and HTML documentations pages as a parsing supports. |
| 37 | + b. Enable one-click import into workspace. |
| 38 | + |
| 39 | +2.Secondary Goal |
| 40 | + a. Implement search and filtering system. |
| 41 | + b. Add users ratings and reviews. |
| 42 | + |
| 43 | +**Implementation Approach** |
| 44 | + |
| 45 | +Phase 1: Backend Automation pipeline |
| 46 | + API collection, parsing, categorization |
| 47 | + |
| 48 | +Phase 2: Backend API |
| 49 | + Enpoints to list, show details, fetch, search and add review |
| 50 | + |
| 51 | +Phase 3: Frontend Integration |
| 52 | + Adds API cards like name, category, rating |
| 53 | + |
| 54 | +Phase 4: One-click import feature |
| 55 | + Workflow |
| 56 | + |__User selects API |
| 57 | + |__Clicks one-click import |
| 58 | + |__Frontend fetches template |
| 59 | + |__Template injected into API Dash workspace |
| 60 | + |
| 61 | +Phase 5: Community Feature |
| 62 | + Ratings and review which will look somewhat like this (images/chaitanya_ratings.png) |
| 63 | + |
| 64 | +**Techstack** |
| 65 | + |
| 66 | +1.Backend Automation pipeline: Python |
| 67 | +2.Backend API: Node.js, Typescript |
| 68 | +3.Frontend: React |
| 69 | +4.Datebase: MongoDB |
| 70 | + |
| 71 | +**Predicted project timeline** |
| 72 | + |
| 73 | +1. Community bonding period: |
| 74 | + This is the phase where I will get to know my mentors better. So I will ask questions to get a clear understanding of the project. Thereby finalize the project scope and workspace structure. |
| 75 | + |
| 76 | +2. Week 1: |
| 77 | + Build multi-format parsing system |
| 78 | + |
| 79 | +3. Week 2: |
| 80 | + Standardize and organize API data |
| 81 | + |
| 82 | +4. Week 3: |
| 83 | + Convert API's into usable API Dash templates |
| 84 | + |
| 85 | +5. Week 4: |
| 86 | + Expose data for frontend |
| 87 | + |
| 88 | +6. Week 5: |
| 89 | + Build API Marketplace UI |
| 90 | + |
| 91 | +7. Week 6: |
| 92 | + Core feature + final polishing |
| 93 | + |
| 94 | +**Note: As the project size is small the week prediction is short and also I will be learing and doing these small things step by step, I may also take mentors meet more and keep on doing things accordingly to make the project successful and wonderful.** |
| 95 | + |
| 96 | + |
| 97 | + |
| 98 | + |
| 99 | + |
| 100 | + |
| 101 | + |
| 102 | + |
| 103 | + |
| 104 | + |
| 105 | + |
| 106 | + |
0 commit comments