mkipcak / marvelql

An open source GraphQL API that wraps the Marvel REST API

MarvelQL

An open source GraphQL API that wraps the Marvel REST API
Try it out now: https://api.marvelql.com/

Description

MarvelQL allows you to send GraphQL queries to Marvel’s REST API to get information about characters, comic series, stories, creators and much more.

Features

1. Query information from Marvel REST endpoints. Here’s a full list of endpoints that can be queried: https://developer.marvel.com/docs
2. Documentation explaining how to use each endpoint and which arguments can be added to queries
3. Deployment to GraphQL Playground so that you can test queries right away

Installation

Make sure you are running Node version 8.10.0

Install using yarn

yarn

Run the server with yarn start

yarn start

A Playground instance will be opened at http://localhost:4000/ (the port number will be printed to the console) to explore the API.

Usage

Send a query in GraphQL playground to get a list of characters and information about them.

{
  characters {
    id
    name
    description
  }
}

Get specific information about one character. Try nesting queries to get more information comics that character is in.

{
  getCharacter(where: { name: "Iron Man" }) {
    id
    name
    description
    comics {
      name
    }
  }
}

Explore the docs and try out different queries.

Elm Client Generation

Follow these installation instructions to add elm-graphql to your Elm project. To generate your client code, run the following command:

elm-graphql https://api.marvelql.com/ --base Marvelql --output src/generated

In step 3 of the installation instructions, you can replace the example api script with the Marvelql command above.

If you need assistance using the generated client code, refer to elm-graphql for examples.

Roadmap

We have plans to keep improving MarvelQL. Here's what is next:

1. Improve the speed of queries
2. Implementation with Hasura, Neo4j, and Elm

Contributing

This is an open source project. To learn how to contribute, please check out our contributing guide.

License

MIT © Novvum

---

Made with ❤️ by Novvum