Docs

Search

Sign In

Home
Essential Knowledge
By Type
Building Blocks
APIs
Releases

LJD Test Topic: Getting Started with XYZ

Topic

Changed on:

12 Apr 2024

Overview

Overview Lorem Ipsum...

The Body...

Create a Fluent GraphQL API in Postman

Author:

Fluent Commerce staff

Changed on:

21 June 2024

Key Points

Open Postman, click Import, then choose "Upload Files" in the dialog box.
Upload the GraphQL SDL File named
```
`fluent-graphql.graphql`
```
.
Confirm settings, including "Include deprecated fields," and click Import; a success message confirms installation in the APIs tab.

Steps

Prerequisites

GraphQL SDL file.

Tip

In order to obtain a GraphQL SDL file, refer to the guide on How to convert a JSON Introspection result to Schema Definition Language (SDL)

Step 1. Open Postman and click on the Import button on the top left of the Postman window.

Step 2. Click on Upload Files in the dialog box.

Step 3. Upload a GraphQL SDL File: fluent-graphql.graphql

Step 4. Select both "API name" and "Postman Collection (from GraphQL)", or choose "GraphQL with a Postman Collection", depending on different Postman versions. Click on "Show Import Settings", and make sure to turn on "Include deprecated fields":

Step 5. Click on Import button

Step 6. Confirmation message is returned

Step 7. Navigate to APIs tab (in left-hand corner), the new API is installed successfully

Convert a JSON Introspection result to Schema Definition Language (SDL)

Author:

Fluent Commerce staff

Changed on:

9 Apr 2024

Key Points

Converting JSON Introspection to SDL allows for a human-readable format of GraphQL schema, which is essential for documentation and understanding the API structure.
Tools such as GraphQL Voyager and Apollo Studio can automate the conversion process, providing a visual representation and SDL output without manual coding.
Understanding the structure of the introspection query result is crucial for manually converting the JSON to SDL, should automated tools not be available or suitable.

Steps

Prerequisites

NodeJS
Response file of a JSON Introspection Query.

Steps to Follow

Open a terminal / command prompt, and run the following command to install the Node package
```
`graphql-introspection-json-to-sdl`
```
```
`npm install -g graphql-introspection-json-to-sdl`
```

Once installed, run the following command to convert a JSON file to GraphQL SDL file.

`graphql-introspection-json-to-sdl <path-to-instrospection-query-result-json-file> > <path-to-result-sdl-file>`

Example (from the same direction as the JSON schema file):

`graphql-introspection-json-to-sdl fluent-graphql.json > fluent-graphql.graphql`

LJD Test Topic: Getting Started with XYZ

Overview

The Body...

Create a Fluent GraphQL API in Postman

Key Points

Steps

Prerequisites

Step 1. Open Postman and click on the Import button on the top left of the Postman window.

Step 2. Click on Upload Files in the dialog box.

Step 3. Upload a GraphQL SDL File: fluent-graphql.graphql

Step 4. Select both "API name" and "Postman Collection (from GraphQL)", or choose "GraphQL with a Postman Collection", depending on different Postman versions. Click on "Show Import Settings", and make sure to turn on "Include deprecated fields":

Step 5. Click on Import button

Step 6. Confirmation message is returned

Step 7. Navigate to APIs tab (in left-hand corner), the new API is installed successfully

Related content

Convert a JSON Introspection result to Schema Definition Language (SDL)

Enable GraphQL Auto Complete in Postman

Convert a JSON Introspection result to Schema Definition Language (SDL)

Key Points

Steps

Prerequisites

Steps to Follow

Related content

Create a Fluent GraphQL API in Postman

Enable GraphQL Auto Complete in Postman

Building Blocks

By Type

Helpful Resources