Merge branch 'foss42:main' into main

Author: GANGSTER0910

README.md

@@ -1,6 +1,19 @@
 # API Dash ⚡️
 
-[![Discord Server Invite](https://img.shields.io/badge/DISCORD-JOIN%20SERVER-5663F7?style=for-the-badge&logo=discord&logoColor=white)](https://bit.ly/heyfoss)
+[![Discord Server Invite](https://img.shields.io/badge/DISCORD-JOIN%20SERVER-5663F7?style=for-the-badge&logo=discord&logoColor=white)](https://discord.com/invite/bBeSdtJ6Ue)
+
+### 🚨🚨 API Dash is participating in GSoC 2025! Check out the details below:
+
+<img src="https://github.com/foss42/apidash/assets/615622/493ce57f-06c3-4789-b7ae-9fa63bca8183" alt="GSoC" width="500">
+
+| | Link |
+|--|--|
+| Learn about GSoC | [Link](https://summerofcode.withgoogle.com) |
+| API Dash GSoC Page | [Link](https://summerofcode.withgoogle.com/programs/2025/organizations/api-dash) |
+| Project Ideas List | [Link](https://github.com/foss42/apidash/discussions/565) |
+| Application Guide | [Link](https://github.com/foss42/apidash/discussions/564) |
+| Discord Channel | [Link](https://discord.com/invite/bBeSdtJ6Ue) |
+
 
 ### Please support this initiative by giving this project a Star ⭐️
 
@@ -277,4 +290,4 @@ You can contribute to API Dash in any or all of the following ways:
 
 ## Need Any Help?
 
-In case you need any help with API Dash or are encountering any issue while running the tool, please feel free to drop by our [Discord server](https://bit.ly/heyfoss) and we can have a chat in the **#foss-apidash** channel.
+In case you need any help with API Dash or are encountering any issue while running the tool, please feel free to drop by our [Discord server](https://discord.com/invite/bBeSdtJ6Ue) and we can have a chat in the **#foss-apidash** channel.

doc/dev_guide/packaging.md

@@ -78,7 +78,84 @@ git push
 
 ## FlatHub (Flatpak)
 
-TODO Instructions
+Steps to generate .flatpak package of API Dash:
+
+1. Clone and build API Dash:
+
+Follow the [How to run API Dash locally](setup_run.md) guide.
+
+Stay in the root folder of the project directory.
+
+2. Install Required Packages (Debian/Ubuntu):
+
+```bash
+sudo apt install flatpak
+flatpak install -y flathub org.flatpak.Builder
+flatpak remote-add --if-not-exists --user flathub https://dl.flathub.org/repo/flathub.flatpakrepo
+```
+
+*if using another linux distro, download flatpak and follow the rest of the steps.
+
+3. Build API Dash project:
+
+```bash
+flutter build linux --release
+```
+
+4. Create flatpak manifest file:
+
+```bash
+touch apidash-flatpak.yaml
+```
+in this file, add:
+
+```yaml
+app-id: io.github.foss42.apidash
+runtime: org.freedesktop.Platform
+runtime-version: "23.08"
+sdk: org.freedesktop.Sdk
+
+command: /app/bundle/apidash
+finish-args:
+  - --share=ipc
+  - --socket=fallback-x11
+  - --socket=wayland
+  - --device=dri
+  - --socket=pulseaudio
+  - --share=network
+  - --filesystem=home
+modules:
+  - name: apidash
+    buildsystem: simple
+    build-commands:
+      - cp -a build/linux/x64/release/bundle /app/bundle
+    sources:
+      - type: dir
+        path: .
+```
+
+5. Create the .flatpak file:
+
+```bash
+flatpak run org.flatpak.Builder --force-clean --sandbox --user --install --install-deps-from=flathub --ccache --mirror-screenshots-url=https://dl.flathub.org/media/ --repo=repo builddir apidash-flatpak.yaml
+
+flatpak build-bundle repo apidash.flatpak io.github.foss42.apidash
+```
+
+The apidash.flatpak file should be the project root folder.
+
+To test it:
+
+```bash
+flatpak install --user apidash.flatpak
+
+flatpak run io.github.foss42.apidash
+```
+To uninstall it:
+
+```bash
+flatpak uninstall io.github.foss42.apidash
+```
 
 ## Homebrew
 

doc/proposals/2025/gsoc/Application_Sohier Lotfy_AI UI Designer for APIs.md

@@ -0,0 +1,78 @@
+### About 
+
+1. Full Name: Sohier Lotfy Elsafty
+2. Email: [email protected]
+3. Phone: +971526738751
+4. Discord handle: soh0869
+5. Website: https://sohier-lotfy.webflow.io/
+6. GitHub: https://github.com/soh-123
+7. Twitter: https://x.com/Namlah__0
+8. LinkedIn: https://www.linkedin.com/in/sohierlotfy/
+9. Time zone: GMT+4
+10. Resume: https://drive.google.com/file/d/1iwzkVZ8W-oqTnLd-lvwuXo7zOdSBsYMI/view?usp=sharing
+
+### University Info
+
+1. University name: Georgia Tech Institute
+2. Program you are enrolled in (Degree & Major/Minor): Masters of computer science
+3. Year: 2024
+5. Expected graduation date: 2028
+
+### Motivation & Past Experience
+
+Short answers to the following questions (Add relevant links wherever you can):
+1. Have you worked on or contributed to a FOSS project before? Can you attach repo links or relevant PRs? 
+  NO
+2. What is your one project/achievement that you are most proud of? Why? 
+  Audiobook generator, although it's non-professional project but it was an idea that came true and I thought of every single piece of it, and built it for myself as me the only user.
+3. What kind of problems or challenges motivate you the most to solve them?
+  the problems that requires creative thinking and the problems that once dug deep and found the core problem you can find the solution easily.
+4. Will you be working on GSoC full-time? In case not, what will you be studying or working on while working on the project?
+  No, I can work part-time as I am a mom and part time master student.
+6. Do you mind regularly syncing up with the project mentors?
+  NO
+7. What interests you the most about API Dash?
+  API Dash looks interesting because it's an open-source, lightweight alternative to Postman and Insomnia, with cross-platform support (including mobile). One standout feature is its ability to preview API responses for images, PDFs, audio, and videos, which most API clients don’t support. It also supports GraphQL, SSE, and WebSockets, making it versatile beyond just REST APIs. Another useful feature is its built-in code generation for multiple languages like Dart, Python, and JavaScript, which speeds up API integration. Since it's built with Flutter, it has a native feel across platforms and is highly customizable.
+8. Can you mention some areas where the project can be improved?
+  - The UI is lightweight, but when handling many APIs, navigation and search could be improved with tagging, categorization, or hierarchical collections.
+  - It supports some languages, but expanding code snippet generation to include Swift, Kotlin, C#, and Rust would be useful.
+  - While it has a clean UI, offering more customization, such as dark mode, font adjustments, and layout options, would enhance usability.
+
+### Project Proposal Information
+
+### **1. Proposal Title**  
+**AI UI Designer for APIs – Automated Visualization of API Responses**  
+
+### **2. Abstract**  
+APIs return structured data in formats like JSON or XML, but developers often spend time manually creating UI components to visualize and interact with this data. This project aims to develop an AI-powered agent that automatically transforms API responses into dynamic, user-friendly UI components. The system will analyze API response structures and generate appropriate UI elements, such as tables, charts, forms, and cards, with customization options. This eliminates the need for manual UI development, improving efficiency and user experience. The generated UI components will be exportable for integration into Flutter or web applications.  
+
+### **3. Detailed Description**  
+#### **Problem Statement**  
+When integrating APIs into applications, developers often need to create custom UI elements to present API responses in an understandable way. This process is time-consuming, repetitive, and requires both front-end and back-end expertise. Automating this step will streamline API consumption and enhance usability.  
+
+#### **Proposed Solution**  
+This project will develop an AI-driven system that:  
+- Parses API responses (JSON, XML) to extract key data structures.  
+- Automatically generates corresponding UI components (tables, charts, forms, cards).  
+- Provides customization options for developers to modify layouts, styles, and interactive elements (filters, pagination, sorting).  
+- Enables real-time UI updates based on API response variations.  
+- Allows easy export of the generated UI components for use in Flutter or web applications.  
+
+#### **Technical Approach**  
+- **Data Parsing & Analysis**: Implement parsers to process API responses and extract hierarchical data.  
+- **AI Model for UI Generation**: Use rule-based mapping and AI models to determine the best UI components for different response structures.  
+- **Dynamic UI Rendering**: Implement a rendering engine in Flutter/Dart to visualize API data interactively.  
+- **Customization & Exporting**: Provide UI customization options and an export function for Flutter/web integration.  
+
+### **4. Weekly Timeline**  
+
+| **Week** | **Tasks** |
+|----------|----------|
+| **Week 1** | Research similar solutions, finalize technical stack, and define core features. |
+| **Week 2** | Implement API response parsers for JSON & XML. Test data extraction on sample APIs. |
+| **Week 3** | Develop AI-based UI mapping logic for different response types (tables, charts, forms, etc.). |
+| **Week 4** | Build dynamic UI rendering components in Flutter. Test auto-generation of UI components. |
+| **Week 5** | Add customization options for developers (styles, filters, sorting). Refine UI/UX. |
+| **Week 6** | Implement export functionality for generated UI. Conduct performance testing. |
+| **Week 7** | Conduct extensive testing on various APIs, fix issues, and optimize performance. |
+| **Week 8** | Finalize documentation, prepare demo, and submit the completed project. |

doc/proposals/2025/gsoc/application_debasmibasu_aiagentforapitesting.md

@@ -0,0 +1,83 @@
+# AI-Powered API Testing and Tool Integration
+
+## Personal Information
+
+- **Full Name:** Debasmi Basu
+- **Email:** [[email protected]](mailto:[email protected])
+- **Phone:** +91 7439640610
+- **Discord Handle:** debasmibasu
+- **Home Page:** [Portfolio](https://debasmi.github.io/portfolio/portfolio.html)
+- **GitHub Profile:** [Debasmi](https://github.com/debasmi)
+- **Socials:**  
+  - [LinkedIn](https://www.linkedin.com/in/debasmi-basu-513726288/)
+- **Time Zone:** Indian Standard Time
+- **Resume:** [Google Drive Link](https://drive.google.com/file/d/1o5JxOwneK-jv2GxnKTrzk__n7UbSKTPt/view?usp=sharing)
+
+## University Info
+
+- **University Name:** Cluster Innovation Centre, University of Delhi
+- **Program:** B.Tech. in Information Technology and Mathematical Innovations
+- **Year:** 2023 - Present
+- **Expected Graduation Date:** 2027
+
+## Motivation & Past Experience
+
+### Project of Pride: Image Encryption using Quantum Computing Algorithms
+
+This project represents my most significant achievement in the field of quantum computing and cybersecurity. I developed a **quantum image encryption algorithm** using **Qiskit**, leveraging quantum superposition and entanglement to enhance security. By implementing the **NEQR model**, I ensured **100% accuracy in encryption**, preventing any data loss. Additionally, I designed **advanced quantum circuit techniques** to reduce potential decryption vulnerabilities, pushing the boundaries of modern encryption methods.
+
+This project is my pride because it merges **cutting-edge quantum computing** with **practical data security applications**, demonstrating the **real-world potential of quantum algorithms in cryptography**. It reflects my deep technical expertise in **Qiskit, Python, and quantum circuits**, as well as my passion for exploring **future-proof encryption solutions**.
+
+### Challenges that Motivate Me
+
+I am driven by challenges that push the boundaries of **emerging technologies, security, and web development**. The intersection of **AI, cybersecurity, web applications, and quantum computing** excites me because of its potential to redefine **secure digital interactions**. My passion lies in building **robust, AI-powered automation systems** that enhance **security, efficiency, and accessibility** in real-world applications. Additionally, I enjoy working on **scalable web solutions**, ensuring that modern applications remain secure and user-friendly.
+
+### Availability for GSoC
+
+- **Will work full-time on GSoC.**
+- I will also dedicate time to exploring **LLM-based security frameworks**, improving **web API integration**, and enhancing my expertise in **AI-driven automation**.
+
+### Regular Sync-Ups
+
+- **Yes.** I am committed to maintaining **regular sync-ups** with mentors to ensure steady project progress and discuss improvements in API security and automation.
+
+### Interest in API Dash
+
+- The potential to integrate **AI-powered automation** for API testing aligns perfectly with my expertise in **web development, backend integration, and security automation**.
+- I see a great opportunity in **enhancing API security validation** using AI-driven techniques, ensuring robust **schema validation and intelligent error detection**.
+
+### Areas for Improvement
+
+- API Dash can expand **real-time collaborative testing features**, allowing teams to test and debug APIs more efficiently.
+- Enhancing **security automation** by integrating **AI-powered API monitoring** would significantly improve API Dash’s effectiveness.
+
+---
+
+## Project Proposal
+
+### **Title**
+
+AI-Powered API Testing and Tool Integration
+
+### **Abstract**
+
+API testing often requires **manual test case creation and validation**, making it inefficient. Additionally, **converting APIs into structured definitions for AI integration** is a complex task. This project aims to **automate test generation, response validation, and structured API conversion** using **LLMs and AI agents.** The system will provide **automated debugging insights** and integrate seamlessly with **pydantic-ai** and **langgraph.** A **benchmarking dataset** will also be created to evaluate various LLMs for API testing tasks.
+
+### **Weekly Timeline**
+
+| Week           | Focus                           | Key Deliverables & Achievements                                        |
+|---------------|--------------------------------|------------------------------------------------------------------------|
+| **Week 1-2**  | Research & Architecture        | Study existing API testing tools, research AI automation methods, explore web-based API testing interfaces, and define the project architecture. Expected Outcome: Clear technical roadmap for implementation. |
+| **Week 3-4**  | API Specification Parsing      | Develop a parser to extract API endpoints, request methods, authentication requirements, and response formats from OpenAPI specs, Postman collections, and raw API logs. Expected Outcome: Functional API parser capable of structured data extraction and visualization. |
+| **Week 5-6**  | AI-Based Test Case Generation  | Implement an AI model that analyzes API specifications and generates valid test cases, including edge cases and error scenarios. Expected Outcome: Automated test case generation covering standard, edge, and security cases, integrated into a web-based UI. |
+| **Week 7-8**  | Response Validation & Debugging | Develop an AI-powered validation mechanism that checks API responses against expected schemas and detects inconsistencies. Implement logging and debugging tools within a web dashboard to provide insights into API failures. Expected Outcome: AI-driven validation tool with intelligent debugging support. |
+| **Week 9-10** | Structured API Conversion       | Design a system that converts APIs into structured tool definitions compatible with pydantic-ai and langgraph, ensuring seamless AI agent integration. Expected Outcome: Automated conversion of API specs into structured tool definitions, with visual representation in a web-based interface. |
+| **Week 11-12**| Benchmarking & Evaluation       | Create a dataset and evaluation framework to benchmark different LLMs for API testing performance. Conduct performance testing on generated test cases and validation mechanisms. Expected Outcome: A benchmarking dataset and comparative analysis of LLMs in API testing tasks, integrated into a web-based reporting system. |
+| **Final Week**| Testing & Documentation        | Perform comprehensive end-to-end testing, finalize documentation, create usage guides, and submit the final project report. Expected Outcome: Fully tested, documented, and ready-to-use AI-powered API testing framework, with a web-based dashboard for interaction and reporting. |
+
+---
+
+## Conclusion
+
+This project will significantly **enhance API testing automation** by leveraging **AI-driven test generation, web-based API analysis, and structured tool conversion**. The benchmarking dataset will provide **a standard evaluation framework** for API testing LLMs, ensuring **optimal model selection for API validation**. The resulting **AI-powered API testing framework** will improve **efficiency, accuracy, security, and scalability**, making API Dash a more powerful tool for developers.
+