apollo-multi-endpoint-link

KO | EN

gitlite — search

#hacktoberfest #typescript #go #golang #android #machine-learning #deep-learning #docker #nodejs #java #windows #awesome-list #pytorch #openai

apollo-multi-endpoint-link

(★ 132)

⛓ Apollo link which add an api directive to fetch data from multi endpoints

File Explorer

Download Latest Version (.zip)

- config.yml
- renovate.json
- settings.yml
- index.ts
- interface.ts
- MultiAPILink.spec.ts
- MultiAPILink.ts
- utils.ts
.eslintrc
.gitignore
.npmrc
bili.config.ts
jest.config.js
LICENSE
package-lock.json
package.json
README.md
SECURITY.md
tsconfig.eslint.json
tsconfig.json

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## Apollo link which add an api directive to fetch data from multi endpoints

[![CircleCI](https://img.shields.io/circleci/build/github/habx/apollo-multi-endpoint-link)](https://app.circleci.com/pipelines/github/habx/apollo-multi-endpoint-link)
[![Version](https://img.shields.io/npm/v/@habx/apollo-multi-endpoint-link)](https://www.npmjs.com/package/@habx/apollo-multi-endpoint-link)
[![Size](https://img.shields.io/bundlephobia/min/@habx/apollo-multi-endpoint-link)](https://bundlephobia.com/result?p=@habx/apollo-multi-endpoint-link)
[![License](https://img.shields.io/github/license/habx/apollo-multi-endpoint-link)](https://raw.githubusercontent.com/habx/apollo-multi-endpoint-link/dev/LICENSE)

### Why ?

We wrote [an article](https://www.habx.com/tech/micro-graphql-schema) about why and how we did this link if you want more details.

### Install

```bash
   npm i @habx/apollo-multi-endpoint-link
```

### Setup

```typescript
import { createHttpLink } from "apollo-link-http";

new ApolloClient({
 link: ApolloLink.from([
   new MultiAPILink({
       endpoints: {
           housings: 'https://housings.api',
           projects: 'https://projects.api',
           ...
       },
       createHttpLink: () => createHttpLink(),
     }),
 ])
})
```

NB: Since default value of `httpSuffix` is `/graphql`, endpoints above will be transformed to `https://housings.api/graphql` and `https://projects.api/graphql`.
If you do not have common suffix, you can pass an empty string as `httpSuffix` to avoid this transformation.

NB 2: Supports [apollo-link-rest](https://github.com/apollographql/apollo-link-rest) library

##### API

```typescript
new MultiAPILink(config, request);
```

###### config

| Parameter       | Description                                                                                                                | Default                | Required |
| --------------- | -------------------------------------------------------------------------------------------------------------------------- | ---------------------- | -------- |
| endpoints       | Dictionary of endpoints                                                                                                    |                        | Yes      |
| defaultEndpoint      | Default endpoint                                                                                                    |                        | No      |
| createHttpLink  | Function to generate http link like [apollo-link-http](https://www.apollographql.com/docs/link/links/http/)                |                        | Yes      |
| createWsLink    | Function to generate wsLink like [apollo-link-ws](https://www.apollographql.com/docs/link/links/ws/)                       |                        | No       |
| wsSuffix        | Suffix added to endpoint for subscriptions queries                                                                         | /graphql/subscriptions | No       |
| httpSuffix      | Suffix added to endpoint for http queries                                                                                  | /graphql               | No       |
| getContext      | Callback function called to set custom [context](https://www.apollographql.com/docs/link/links/http/#context) like headers |                        | No       |
| prefixTypenames | Add name argument passed in `@api` directive to every \_\_typename contained in network data response                      |                        | No       |

### Queries

#### Query with static api name :

```graphql
query projectList($params: Params) @api(name: projects) {
  projects(params: $params) {
    nodes {
      id
      name
    }
  }
}
```

```ts
const response = useQuery(myQuery);
```

#### Query with dynamic api name

```graphql
query projectList($params: Params) @api(contextKey: "apiName") {
  projects(params: $params) {
    nodes {
      id
      name
    }
  }
}
```

```ts
const response = useQuery(myQuery, { context: { apiName: "projects" } });
```

#### Setting custom context

Sometimes you might need to set custom [apollo link context](https://www.apollographql.com/docs/link/links/http/#context) like `headers` for authentication purpose.
This link allows it by doing as following.

```typescript
new MultiAPILink({
    getContext: (endpoint) => {
      if (endpoint === 'yourendpoint-with-auth') {
        return ({
          headers: {
            'Authorization': 'xxxx',
          }
        })
      }
      return {}
    },
    ...
})
```

apollo-multi-endpoint-link

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

apollo-multi-endpoint-link

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README