IBM API Connect has supported GraphQL as a powerful way for developers to consume modern APIs. Now, Developer Portal takes a major step forward by integrating the StepZen GraphiQL Explorer—bringing a richer, more intuitive experience to API consumers for testing GraphQL endpoints.
What’s New
The legacy GraphQL testing interface has been replaced with the StepZen GraphiQL Explorer, a feature-packed tool designed to simplify query authoring and exploration. Available in both the Developer Portal and the Consumer Catalog, this update delivers an enhanced testing experience across environments.
Who Benefits
This enhancement directly impacts API consumers using GraphQL APIs. Instead of writing queries manually, they can now leverage an interactive, schema-aware environment within the Portal.
Why It Matters
-
Schema-Driven Exploration: Instantly view available schema types, fields, and relationships through the Docs panel.
-
Reduced Complexity: Use the Builder to construct queries visually, without memorising query syntax.
-
Smarter Workflows: Query history and saved examples allow for faster iteration and testing.
- UI Consistency: Built with the IBM Carbon Design System, ensuring a seamless and familiar experience across API Connect.
By simplifying GraphQL testing and lowering the learning curve, the Explorer accelerates API adoption, reduces support overhead, and empowers consumers to create value from APIs faster.
How to Use the New GraphQL Explorer
1. Publish your GraphQL API
Upload and publish your GraphQL API through API Manager. Refer to these guides for creating a GraphQL proxy API:
2. Access in Developer Portal
Once published, go to the Developer Portal and open the Test Tool for your API.
3. Explore Using GraphiQL
Docs: Browse schema types, available queries, and input fields.
The interactive documentation allows consumers to drill down into field-level details, understand relationships between objects, and instantly see what parameters and response structures are supported—eliminating the need to constantly switch back to static API documentation.
History: View and reuse past queries for quick testing.
Builder: Build queries interactively by selecting fields and parameters.
Copy Code:
The integration of the StepZen GraphiQL Explorer represents a significant usability improvement for GraphQL APIs in API Connect. By reducing the barrier to entry for API consumers and offering a guided query-building experience, this feature strengthens the Developer Portal as a go-to hub for testing and learning.
Whether you are an experienced developer or just starting with GraphQL, the new Explorer ensures you spend less time debugging syntax and more time building with APIs.
https://www.ibm.com/docs/en/api-connect/10.0.8_lts?topic=overview-whats-new-in-latest-release-version-10083#overview_whatsnew_revised__section_consumers__title__1