GraphQL Playground Support in API Gateway

API Gateway supports GraphQL endpoints in Non-Infor API Suites and provides GraphQL Playground for schema exploration and running queries by using configured endpoint security settings.

GraphQL Playground is available for GraphQL endpoints configured in Non-Infor API Suites. It enables administrators to upload schemas, retrieve schemas through introspection, explore type definitions, and run queries within API Gateway.

What is GraphQL?

GraphQL is a query language and runtime for APIs. It allows clients to request specific data fields from a single endpoint instead of relying on multiple fixed REST endpoints.

A GraphQL API responds with data that matches the structure of the submitted query. Clients control which fields are returned and how related objects are retrieved.

Key characteristics of GraphQL

  • Precise field selection: Clients request only the fields required for a specific use case.
  • Single endpoint access: Multiple related resources can be retrieved in one query.
  • Strongly typed schema: Each GraphQL API defines types, fields, queries, and mutations in a schema.
  • Flexible response structure: Different clients can request different field combinations without creating additional endpoints.
  • Schema-based validation: Queries are validated against the schema before running the query.

Audience and scope

This feature applies to users with the IONAPI-Administrator role who manage Non-Infor API Suites in API Gateway.

Authorized users can:

  • Add and configure GraphQL endpoints.
  • Upload GraphQL schema files.
  • Retrieve schemas using introspection.
  • Access and use GraphQL Playground.
  • Manage endpoint documentation formats.

Feature overview

  • GraphQL endpoint support for Non-Infor API Suites.
  • Schema upload in SDL format.
  • Schema retrieval using introspection.
  • Integrated GraphQL Playground interface.
  • Schema download capability.
  • Support for light and dark display themes.

How GraphQL Playground works

When a GraphQL endpoint is added to API Gateway, administrators associate a schema with the endpoint either by uploading a schema file or by retrieving it through introspection.

The associated schema enables:

  • Auto-completion in the query editor.
  • Schema exploration through the documentation panel.
  • Validation of queries before running the query.

Queries run in GraphQL Playground use the authentication configuration defined for the endpoint.

Prerequisites

  • IONAPI-Administrator role in API Gateway.
  • Access to a Non-Infor API Suite.
  • A GraphQL endpoint URL.
  • A GraphQL schema file in SDL format or an endpoint that supports introspection.

Availability and limitations

  • Available only for Non-Infor API Suites.
  • GraphQL APIs are not supported in API Metadata.
  • Schema files must be valid GraphQL Schema Definition Language (SDL) format.
  • Schema file size is subject to API Gateway upload limits.
  • Schema introspection requires the endpoint to support introspection.