Skip to content
This repository has been archived by the owner on Jun 6, 2019. It is now read-only.

Latest commit

 

History

History
111 lines (76 loc) · 4.01 KB

README.md

File metadata and controls

111 lines (76 loc) · 4.01 KB

NOT MAINTAINED ANYMORE


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!