# graphql-js-schema-fetch

**Repository Path**: mirrors_Shopify/graphql-js-schema-fetch

## Basic Information

- **Project Name**: graphql-js-schema-fetch
- **Description**: Module that fetches the JSON representation of the GraphQL schema from a live server
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2026-01-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Travis](https://travis-ci.com/Shopify/graphql-js-schema-fetch.svg?branch=master)](https://travis-ci.com/Shopify/graphql-js-schema-fetch)

# graphql-js-schema-fetch

It fetches the JSON representation of the GraphQL schema from a live server

## Table Of Contents

- [Installation](#installation)
- [Examples](#examples)
- [API](#api)
- [License](http://github.com/Shopify/graphql-js-schema-fetch/blob/master/LICENSE.md)

## Installation

#### With Yarn:

```bash
$ yarn global add graphql-js-schema-fetch
```

#### With NPM:

```bash
$ npm install -g graphql-js-schema-fetch
```

## Examples

To fetch the json representation of the graphql schema from a live server that
implements the GraphQL (and optionally the Relay) spec, run:

```bash
graphql-js-schema-fetch https://www.my-server.com/api
```

If your server requires additional credentials or headers, use the `--header`
option:

```bash
graphql-js-schema-fetch https://www.my-server.com/api --header "Authorization: Basic abc123" --header "X-API-Version: 1.1"
```

If your server uses something other than the `POST` method for its API, use the
`--method` option:

```bash
graphql-js-schema-fetch https://www.my-server.com/api --method GET
```

## API

#### `const instance = graphqlJsSchemaFetch(url, method, [headers]);`

Params you can pass `graphqlJsSchemaFetch`:
- `url` - The url where your GraphQL API resides
- `method` - The HTTP method to use while making the request
- `headers` - A hash representing the key value pairs of headers to pass to
  `node-fetch`

## License

MIT, see [LICENSE.md](http://github.com/Shopify/graphql-js-schema-fetch/blob/master/LICENSE.md) for details.

<img src="https://cdn.shopify.com/shopify-marketing_assets/builds/19.0.0/shopify-full-color-black.svg" width="200" />