✨ feat(api): add GraphQL support to enhance data querying flexibility

[annaelmoussa]

Add GraphQL Support to Octagon API

Description

This PR introduces GraphQL support to our Octagon API, enhancing the flexibility and efficiency of data querying for our users.

Changes

• Implemented GraphQL schema for existing data models
• Added GraphQL resolvers for fighters, rankings, and divisions
• Integrated GraphQL server with existing Hono setup
• Updated API documentation to include GraphQL usage and examples
• Added GraphQL endpoint (/graphql) alongside existing REST endpoints

Testing

• Manually tested GraphQL queries for all main data types
• Verified that existing REST endpoints continue to function as expected
• Tested GraphQL playground for interactive query exploration

Documentation

• Updated README.md with GraphQL information
• Added detailed GraphQL documentation in api-documentation.mdx

Dependencies

• Added @graphql-tools/schema for schema creation
• Added @hono/graphql-server for GraphQL server integration with Hono

Notes for Reviewers

• Please check the GraphQL schema design for any potential improvements
• Verify that the integration doesn't impact the performance of existing endpoints
• Suggestions for additional example queries in the documentation are welcome

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
octagon-api	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 7, 2024 9:29am

[victor-lillo]

Hello @annaelmoussa! First of all, thanks for contributing to the repo!

I will be away on vacation for a few days. I will check this PR when I'm back and as soon as possible.

[annaelmoussa]

Hi @victor-lillo,

Thank you for your response and for taking the time to reply.

Enjoy your vacation! When you're back, please check the GraphQL schema design for any potential improvements. Also, make sure the integration doesn't impact the performance of existing endpoints. If you have any suggestions for additional example queries to include in the documentation, they are more than welcome.

Have a great holiday and see you soon!