Fluent Commerce Logo
Docs
Help & Feedback
Sign In

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

How-to Guide

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

Step arrow right iconPrerequisites

  • NodeJS
  • Response file of a JSON Introspection Query.

Step arrow right iconSteps 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`

Related content

Create a Fluent GraphQL API in Postman
Edited 10 days ago
Enable GraphQL Auto Complete in Postman
Edited 201 days ago
Fluent Commerce staff

Fluent Commerce staff

Building Blocks
All Building Blocks
Packages & Modules
UI Components
Workflows
Settings
Interface Contracts
Rules
By Type
All Types
How-to Guides
Topics
Essential Knowledge
Releases
Sitemap
Use Cases
Glossary
Legal Resources
Platform Limits
Support Policy
Service Level Agreement (SLA) - Enterprise
Service Level Agreement (SLA) - Professional
Deprecation Policy
Extend Knowledge Content – Terms and Conditions
Information Security Policy
Data Privacy Addendum
System and Organization Controls (SOC) 3 Report

Copyright © 2024 Fluent Retail Pty Ltd (trading as Fluent Commerce). All rights reserved. No materials on this docs.fluentcommerce.com site may be used in any way and/or for any purpose without prior written authorisation from Fluent Commerce. Current customers and partners shall use these materials strictly in accordance with the terms and conditions of their written agreements with Fluent Commerce or its affiliates.

Fluent Logo