https://github.com/cmmartti/fractal-style-schema

An example of a Graphene-Python GraphQL schema where each entity is in its own module.
https://github.com/cmmartti/fractal-style-schema

graphene-python graphql python

Last synced: about 1 month ago
JSON representation

An example of a Graphene-Python GraphQL schema where each entity is in its own module.

• Host: GitHub
• URL: https://github.com/cmmartti/fractal-style-schema
• Owner: cmmartti
• Created: 2018-06-01T01:47:48.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-08-18T03:43:44.000Z (over 6 years ago)
• Last Synced: 2024-11-24T01:28:20.062Z (about 1 month ago)
• Topics: graphene-python, graphql, python
• Language: Python
• Homepage:
• Size: 12.7 KB
• Stars: 24
• Watchers: 5
• Forks: 7
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Fractal-Style GraphQL Schema

This is an example of a fractal style GraphQL schema for [Graphene-Python](http://graphene-python.org/), where each entity is in its own module. Within each module are `mutation`, `type`, `query`, `subscription`, `resolvers` etc. files that contain all of the types, queries, mutations, etc. for that entity. This organisation method avoids the issue of overly-long schema files that contain dozens or hundreds of types and resolvers.

This specific example is a simple read-only query API for video games and characters.

The `graphql_api.auto.schema_operations_builder` function assembles each part into a whole Query/Mutation, which can then be passed to `graphene.Schema` to create a schema.

Circular dependencies are met using Graphene's [`lazy_import`](https://github.com/graphql-python/graphene/blob/master/graphene/utils/module_loading.py) utility function.

## Setup

This GraphQL API is built on Django. Follow the steps below to run it on your machine:

1. Create a Python virtual environment:

    Python2: `virtualenv venv`

    Python3: `python venv venv`

2. Activate the virtual environment:

    Windows: `venv\Scripts\activate`

    *nix: `source venv/bin/activate`

3. Install dependencies:

    `pip install -r requirements.txt`

4. Start the dev server:

    `python manage.py runserver`

5. Open your browser to localhost:8000/graphql to view the GraphiQL IDE.

---

Based on code examples by [ahopkins](https://github.com/graphql-python/graphene/issues/545#issuecomment-329630141) (Adam Hopkins) and [ProjectCheshire](https://github.com/graphql-python/graphene/issues/714#issuecomment-391211693) (Jessamyn Hodge).