Giter VIP home page Giter VIP logo

apollo-bridge-link's Introduction

Apollo Bridge Link

When you don't have GraphQL server (yet) and want to use GraphQL on the client.

Demo: working example with source code and server.

Article about how to use it with dataloaders and authentication.

Use your own resolvers to non-graphql endpoints (like REST API, querying filesystem in electron app etc.).

current version travis.ci codecov Greenkeeper badge license

Idea

GraphQL client side development is great experience. But more then often company doesn't have GraphQL server (yet). Bridge allows you to resolve GraphQL queries and mutations the way you want (facing REST API eg.)

Allows gradual implementing of GraphQL within your project and doesn't require to change backend. Schema created along the way will be corner stone for full adoption of GraphQL on the backend.

Implementation

We created this tool for us to deliver web and native app. We use Apollo tools and therefore this is implemented as Apollo Link.

The basic implementation is simple: this link allows you to create link that accepts your schema and your resolvers. You can even mock the schema on the client.

Demo: working example with source code and server.

How to use

Install

npm install apollo-client@beta apollo-bridge-link apollo-cache-inmemory@beta

create Apollo client

import { ApolloClient } from 'apollo-client';
import { BridgeLink } from 'apollo-bridge-link';
import { InMemoryCache } from 'apollo-cache-inmemory';

// your prepared schema (as txt or parsed)
import schema from './schema';

// your resolvers (see example)
import resolvers from './resolvers';

// if you want to mock anything in the schema (that has not resolver or doesn't return data)
const mock = true;

// if you want to push something down to the resolvers in context
const context = {
  graphQl: 'is cool',
};

// do something with actual context and operation of gql operation
// and return object that will be shallow merged to context
// use for init dataloader with token for example
// see example... https://github.com/dacz/apollo-bridge-link-example
const contextware = (ctx, operation) => ({ inContext: 'from contextware' });

export const client = new ApolloClient({
  link: BridgeLink({ schema, resolvers, mock, context, contextware });
  cache: new InMemoryCache({ addTypename: true }),
});

Then use your graphQl queries and mutation as you would be facing GraphQL server.

Demo: working example with source code and server.

Need help, want help?

I eat my dog (cat, actually) food - I use this for client's projects. I do not have enough time to put all enhancements into this library, but I am catching up.

If you are developer, please submit issue or PR.

If you are company and want to help with implementing GraphQL (server/web app/react native apps) and need help, ask me. I'm passionate programmer (Node, React, GraphQl, ... ) and usually working in a team with more skills like ReactNative.

To Do

  • make example (against REST, with dataloader) - see here
  • make better build

Sponsors

LiveAndCode - passionate group of javascript developers (contact [email protected]). Thanks!

apollo-bridge-link's People

Contributors

dacz avatar greenkeeper[bot] avatar greenkeeperio-bot avatar

Stargazers

Peter Vasilevskiy avatar

Watchers

James Cloos avatar Peter Vasilevskiy avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.