flutter/apidash
1
0
Fork 0
mirror of https://github.com/foss42/apidash.git synced 2025-12-11 15:49:48 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' of github.com:ayaan-md-blr/apidash

Browse Source
This commit is contained in:
sumaiya shazad
2025-03-23 08:24:41 +05:30
parent c3a6df9627 3ed4e07802
commit c4bb335a27
1 changed files with 24 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
doc/proposals/2025/gsoc/idea_Mohammed_Ayaan_ai_ui_designer.md
View File

@@ -1,10 +1,10 @@
### Initial Idea Submission ### Initial Idea Submission
Full Name: Mohammed Ayaan Full Name: Mohammed Ayaan
University name: PES University Bangalore University name: PES University Bangalore
Program you are enrolled in (Degree & Major/Minor): BTech (AI/ML) Program you are enrolled in (Degree & Major/Minor): BTech (AI/ML)
Year: 2nd year (2023-2027) Year: 2nd year (2023-2027)
Expected graduation date: 2027 Expected graduation date: 2027
Project Title: AI UI Designer for APIs Project Title: AI UI Designer for APIs
Relevant issues: #617 Relevant issues: #617
@@ -19,26 +19,28 @@ Proposed solution -
When the API responses are of type xml/json we can show additional advanced preview action buttons on the When the API responses are of type xml/json we can show additional advanced preview action buttons on the
response widget. eg : Data table, Chart, Summary response widget. eg : Data table, Chart, Summary
#12-Mar-2025 - Proof of concept/ update # 12-Mar-2025 - Proof of concept/ update
I executed a quick proof of concept using chatgpt and the results were amazing. I executed a quick proof of concept using chatgpt and the results were amazing.
=> I was able to generate entire flutter widget with customizations. This essentially means that our static widget screens now => I was able to generate entire flutter widget with customizations. This essentially means that our static widget screens now
can be mere placeholders/containers which render the widgets given by the llm codegen service. can be mere placeholders/containers which render the widgets given by the llm codegen service.
=>We need not restrict on the type of charts we can support. We can in fact take guidance from llm on what => We need not restrict on the type of charts we can support. We can in fact take guidance from llm on what
kind of charts can be helpful in analyzing the data and pick may be the best 5 types kind of charts can be helpful in analyzing the data and pick may be the best 5 types
=>However we need to have control on the look and feel and apidash ui standards. These can be provided => However we need to have control on the look and feel and apidash ui standards. These can be provided
as inputs to the prompt. eg: top/bottom margins should be 5%, bar graph color must be blue, or width of as inputs to the prompt. eg: top/bottom margins should be 5%, bar graph color must be blue, or width of
bars must be 5 px etc. bars must be 5 px etc.
Sample charts generated using json data.<br/> Sample charts generated using json data.
(images/data_table.png)</br>
(images/chart.png)<br/> ![](images/data_table.png)
![](images/chart.png)
We can design a fixed layout as per apidash ui standards (font, colors, themes) for each of the We can design a fixed layout as per apidash ui standards (font, colors, themes) for each of the
visualization. This would comprise the static content by reusing the existing widgets. This will ensure visualization. This would comprise the static content by reusing the existing widgets. This will ensure
uniform look and feel for all users. uniform look and feel for all users.
for eg: datatable_page.dart, chart_page.dart, summary_page.dart for eg: datatable_page.dart, chart_page.dart, summary_page.dart
Dynamic data based on the json/xml input would come from the codellama service. for eg: visualizations_service.dart. Dynamic data based on the json/xml input would come from the codellama service. for eg: visualizations_service.dart.
@@ -50,17 +52,17 @@ by the codellama service.
To ensure the kind of output(html/dart code or the transforming the json/xml data) we need, To ensure the kind of output(html/dart code or the transforming the json/xml data) we need,
we can provide the llm with few shot prompts as examples. we can provide the llm with few shot prompts as examples.
On click of Data table => On click of Data table =>
call visualization_service.dart to get the dynamic content from json/xml as required for data table. call visualization_service.dart to get the dynamic content from json/xml as required for data table.
Render the widget. Widget to provide capabilities to sort and search Render the widget. Widget to provide capabilities to sort and search
On click of Chart => On click of Chart =>
We can ask for additional inputs like which type of chart, on what columns etc. We can ask for additional inputs like which type of chart, on what columns etc.
call visualization_service.dart to get the dynamic content from json/xml as required for chart widget. call visualization_service.dart to get the dynamic content from json/xml as required for chart widget.
Render the widget. Multiple chart types can be supported like bar graph, pie, bubble etc. Render the widget. Multiple chart types can be supported like bar graph, pie, bubble etc.
On click of Summary => On click of Summary =>
We can provide some options like top 5 data points(eg: positive reviews/ratings), group by We can provide some options like top 5 data points(eg: positive reviews/ratings), group by
or outliers, book summary, weather report etc or outliers, book summary, weather report etc
call visualization_service.dart to get the dynamic content from json/xml as required for summary widget. call visualization_service.dart to get the dynamic content from json/xml as required for summary widget.
Additionally I can perhaps also contribute to the har importer project. I do have some exposure to har formats. Additionally I can perhaps also contribute to the har importer project. I do have some exposure to har formats.
I will analyze and update the idea shortly. I will analyze and update the idea shortly.