Enable GraphQL Auto Complete in Postman

Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases

How-to Guide

Author:

Fluent Commerce

Changed on:

13 Dec 2023

Key Points

Prerequisites
Steps to Follow

Steps

Prerequisites

The following dependencies are required for this How To

Postman
NodeJS
A valid Fluent Account and Environment file.

Step-by-step guide

Step 1: Introspect the Fluent GraphQL Schema

Refer to the guide on How to Introspect the Fluent GraphQL Schema.

Step 2: Save the response to a file

This is easily done in the Postman Response pane, by selecting the "Save Response" dropdown on the right. No alt provided

Give it a meaningful name: `fluent-graphql.json`

Step 3: Convert the JSON GraphQL Schema to GraphQL Schema Definition Language (SDL)

Use the response file from Step 2: Save the response to a file and refer to the guide on How to convert a JSON Introspection result to Schema Definition Language (SDL).

GraphQL Schema formats and Postman

Postman does support using the JSON GraphQL Schema to create an API, however this does not seem to work for auto-completion, so please convert to a SDL file for a successful result!

Step 4: Create a new Postman API and collection

Refer to the guide on How to Create a Fluent GraphQL API in Postman

Step 5: Configure the GraphQL Request Body to validate against the GraphQL API

Open a new Request window, and configure it for GraphQL.
Click on the No schema dropdown (you may need to click on the refresh button first), and select the GraphQL API installed in Step 4

In the Query pane, use `Ctrl + Space` to initiate auto-completion!
Click on the thumbnails below for examples.

Copyright © 2024-2026 Fluent Retail Pty Ltd (trading as Fluent Commerce). Unless otherwise expressly stated in a current written agreement with Fluent Commerce or any of its affiliates or on any single page of the docs.fluentcommerce.com site, use of the materials on this site is strictly limited to viewing by individuals over 18 years old for legitimate commercially appropriate reasons; and any downloading, copying or other actions or uses of any kind or by any means of the materials on this site, including by artificial intelligence tools, is strictly prohibited. All other rights reserved.

Step 3: Convert the JSON GraphQL Schema to GraphQL Schema Definition Language (SDL)

Use the response file from Step 2: Save the response to a file and refer to the guide on How to convert a JSON Introspection result to Schema Definition Language (SDL).

GraphQL Schema formats and Postman

Postman does support using the JSON GraphQL Schema to create an API, however this does not seem to work for auto-completion, so please convert to a SDL file for a successful result!

Step 5: Configure the GraphQL Request Body to validate against the GraphQL API

Open a new Request window, and configure it for GraphQL.
Click on the No schema dropdown (you may need to click on the refresh button first), and select the GraphQL API installed in Step 4

In the Query pane, use `Ctrl + Space` to initiate auto-completion!
Click on the thumbnails below for examples.

Enable GraphQL Auto Complete in Postman

Key Points

Steps

Prerequisites

Step-by-step guide

Step 1: Introspect the Fluent GraphQL Schema

Step 2: Save the response to a file

Step 3: Convert the JSON GraphQL Schema to GraphQL Schema Definition Language (SDL)

Step 4: Create a new Postman API and collection

Step 5: Configure the GraphQL Request Body to validate against the GraphQL API

Fluent Commerce

Building Blocks

By Type

Helpful Resources

Quick Links

Prerequisites

Step 1: Introspect the Fluent GraphQL Schema

Step 2: Save the response to a file

Step 3: Convert the JSON GraphQL Schema to GraphQL Schema Definition Language (SDL)

Step 4: Create a new Postman API and collection

Step 5: Configure the GraphQL Request Body to validate against the GraphQL API