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

[Feature Request]: Migrate REST API to GraphQL #196

Open
4 of 5 tasks
muskan171105 opened this issue Jan 12, 2025 · 2 comments
Open
4 of 5 tasks

[Feature Request]: Migrate REST API to GraphQL #196

muskan171105 opened this issue Jan 12, 2025 · 2 comments
Assignees
Labels
backend discussion documentation Improvements or additions to documentation enhancement New feature or request frontend swoc25

Comments

@muskan171105
Copy link

Is there an existing issue for this?

  • I have searched the existing issues

Feature Description

Currently, the backend uses REST API for handling routes like /uploadImage and /uploadMetaData. This feature request proposes migrating the existing REST API to GraphQL to improve the efficiency, flexibility, and scalability of the project.

GraphQL will consolidate multiple REST endpoints into a single /graphql endpoint and provide the ability for clients to query only the data they need. Additionally, GraphQL will simplify fetching nested or related data compared to REST.

Use Case

This feature will:

  • Allow users to fetch and send only the required data, improving network efficiency.
  • Simplify API interactions by consolidating multiple endpoints into one.
  • Provide a more flexible and scalable API structure, especially useful for complex queries involving nested data.

Benefits

  1. Flexibility: Clients can request exactly the data they need, reducing over-fetching or under-fetching.
  2. Efficiency: GraphQL reduces the need for multiple network requests to fetch related data.
  3. Scalability: As the project grows, managing and extending the API will be more straightforward.
  4. Developer Experience: Simplified schema design and auto-documentation of GraphQL APIs enhance both frontend and backend development.

Priority

High

Record

  • I agree to follow this project's Code of Conduct
  • I'm a WOB contributor
  • I want to work on this issue
  • I'm willing to provide further clarification or assistance if needed.
@github-actions github-actions bot added backend discussion documentation Improvements or additions to documentation enhancement New feature or request frontend labels Jan 12, 2025
Copy link

You've successfully raised your issue, We'll get back to you soon. Don't forget to star⭐ the Repo.

@4darsh-Dev
Copy link
Owner

assigned to you @muskan171105

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend discussion documentation Improvements or additions to documentation enhancement New feature or request frontend swoc25
Projects
None yet
Development

No branches or pull requests

2 participants