Tutorial: Connector

NOTE: This example accesses data from a REST API, but the data could also come from a database or, really, anywhere that can give a response we can convert to JSON.

Table of Contents

• Initial Data Source Setup
• > Create a Connector
• Create a Model
• Write a GraphQL Schema
• Write Resolvers
• Use Development Modes

In This Section

• Create Your Connector
• Write Tests for the Connector

Create Your Connector

  import { GraphQLConnector } from '@gramps/gramps-express';
- // TODO: change `YourDataSourceConnector` to a descriptive name
- export default class YourDataSourceConnector extends GraphQLConnector {
+ export default class IMDBAPIConnector extends GraphQLConnector {
    /**
-    * TODO: describe this API endpoint
+    * API for looking up movie info
     * @member {string}
     */
-   apiBaseUri = `https://example.org/v2`;
+   apiBaseUri = `https://www.theimdbapi.org/api`;
  }

NOTE: The GraphQLConnector class sets up a lot of core functionality in the background, including methods for sending queries and mutations, plus helpers for caching data. For more information on what’s happening behind the scenes, see the source code.

Write Tests for the Connector

  import { GraphQLConnector } from '@gramps/gramps-express';
  import Connector from '../src/connector';
- // TODO: Update the data source name.
- const DATA_SOURCE_NAME = 'YourDataSource';
+ const DATA_SOURCE_NAME = 'IMDBAPI';
  const connector = new Connector();
  describe(`${DATA_SOURCE_NAME}Connector`, () => {
    it('inherits the GraphQLConnector class', () => {
      expect(connector).toBeInstanceOf(GraphQLConnector);
    });
    it('uses the appropriate URL', () => {
-     // TODO: Update the data source API endpoint.
-     expect(connector.apiBaseUri).toBe(`https://example.org/v2`);
+     expect(connector.apiBaseUri).toBe(`https://www.theimdbapi.org/api`);
    });
  });

@jlengstorf: ~/dev/gramps-graphql/data-source-imdbapi  (master)
$ yarn test
yarn run v1.2.1
$ npm run lint --silent && npm run test:unit --silent
 PASS  test/resolvers.test.js
 PASS  test/connector.test.js
 PASS  test/model.test.js
 PASS  test/index.test.js
Test Suites: 4 passed, 4 total
Tests:       16 passed, 16 total
Snapshots:   0 total
Time:        1.839s
Ran all test suites.
--------------|----------|----------|----------|----------|----------------|
File          |  % Stmts | % Branch |  % Funcs |  % Lines |Uncovered Lines |
--------------|----------|----------|----------|----------|----------------|
All files     |      100 |      100 |      100 |      100 |                |
 connector.js |      100 |      100 |      100 |      100 |                |
 index.js     |      100 |      100 |      100 |      100 |                |
 model.js     |      100 |      100 |      100 |      100 |                |
 resolvers.js |      100 |      100 |      100 |      100 |                |
--------------|----------|----------|----------|----------|----------------|
✨  Done in 4.83s.

Next Up: Create a Model