Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft: API Explorer UI Wireframe #719

Merged
merged 4 commits into from
Mar 30, 2025

Conversation

aakarshgopishetty
Copy link
Contributor

@aakarshgopishetty aakarshgopishetty commented Mar 27, 2025

PR Description

This PR adds 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 Link:
View on Excalidraw

The wireframe is stored in the doc/api-explorer-design/ directory and includes:

  • README.md (Design explanation)
  • wireframe.png (If applicable)

Related Issues


Checklist

  • I have gone through the contributing guide
  • I have updated my branch and synced it with the project main branch before making this PR
  • This is a draft PR for review before frontend implementation

Added/Updated Tests?

  • Yes
  • No, as this PR only adds documentation and UI design

OS on which you have developed and tested the feature?

  • Windows
  • macOS
  • Linux

@animator animator merged commit 1e642ea into foss42:main Mar 30, 2025
@animator
Copy link
Member

@aakarshgopishetty As the application window has already opened. Please submit the full proposal for API Explorer as soon as possible.

@aakarshgopishetty
Copy link
Contributor Author

Thanks for merging the PR and the guidance! I’ve submitted my full proposal as well. Just curious, how does the review process work from here?

@animator
Copy link
Member

After this step, you need to continue working on the project, send draft PRs (as they will count towards the final ranking) until the final result is announced.

@aakarshgopishetty
Copy link
Contributor Author

Got it, thanks for the clarification! I’ll continue working and submitting draft PRs. Just wondering, is there a specific timeline or criteria that play a major role in the final selection?

@animator
Copy link
Member

  • problem statement understanding
  • code quality
  • innovation

@aakarshgopishetty
Copy link
Contributor Author

Hi @animator,

I’m starting the implementation phase for the API Explorer feature. Before I begin coding, I want to ensure my approach aligns with the project’s structure.

Does API Dash have an existing API request-handling system, or should I implement it from scratch?

Are there any specific best practices or coding guidelines I should follow while adding this feature?

Would adding API categorization, search filters, or import/export options be useful for improving the user experience?

I’ll start coding based on the existing architecture and submit a draft PR soon. Let me know if there are any additional pointers before I begin!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants