Testing a StepZen GraphQL API with Postman | StepZen
Published:
Sean Keegan from Postman joins Anthony Campolo to demonstrate how Postman's testing and collaboration tools enhance developing GraphQL APIs with StepZen.
Episode Summary
In this episode, Sean Keegan from Postman joins Anthony Campolo to showcase how Postman’s testing and collaboration tools can enhance the development of GraphQL APIs using StepZen. They walk through creating a StepZen project that combines data from multiple sources, including REST and GraphQL APIs. The hosts demonstrate how to test these endpoints using Postman, highlighting features such as sending GraphQL queries, working with query variables, and viewing response metrics. They also explore Postman’s collaboration features, including shared workspaces and the ability to leave comments on requests. The episode provides insights into the benefits of using Postman for API development and testing, particularly when working with GraphQL and multiple data sources.
Chapters
00:00 - Introduction and Overview
Anthony Campolo introduces the StepZen stream and welcomes Sean Keegan from Postman. They discuss their backgrounds as former teachers who transitioned into the tech industry. Sean provides an overview of Postman, describing it as an API collaboration platform that helps with all parts of the API lifecycle. They touch on the recent growth of Postman as a company and its significance in the API ecosystem. This chapter sets the stage for the demonstration and discussion that follows, providing context for viewers about the speakers’ backgrounds and the tools they’ll be exploring.
02:56 - Setting Up the StepZen Project
Anthony begins setting up a StepZen project, explaining that StepZen is a GraphQL tool for stitching together various backend data sources. He creates a project that will include endpoints for a REST API, a GraphQL API, and some mock test data. Anthony walks through the process of creating the necessary files and schemas, explaining each step along the way. This chapter provides a hands-on introduction to StepZen, demonstrating how to set up a basic project that combines different types of data sources into a single GraphQL API.
07:41 - Creating and Testing Queries in Postman
The hosts move on to creating and testing queries in Postman. They start by setting up a collection and creating an HTTP request for GraphQL. Anthony demonstrates how to set headers, including authentication, and how to structure GraphQL queries in Postman. They test queries for mock data, the Rick and Morty API, and a Pokemon API, showcasing how Postman handles different types of requests. This chapter highlights Postman’s capabilities for working with GraphQL APIs and demonstrates the process of setting up and sending queries.
26:20 - Comparing REST and GraphQL Responses
Anthony and Sean compare the responses from REST and GraphQL endpoints, highlighting the differences in data size and structure. They demonstrate how GraphQL allows for more precise data fetching, resulting in smaller response sizes compared to REST endpoints. This chapter provides insights into the benefits of GraphQL for efficient data retrieval and how Postman can be used to visualize these differences.
33:03 - Using Schemas for Auto-completion in Postman
Anthony demonstrates how to create a schema in Postman to enable auto-completion for GraphQL queries. He shows how to define types and queries in the schema, then applies it to the existing requests. This feature enhances the developer experience by providing intelligent suggestions while writing queries. The chapter illustrates how Postman’s schema support can streamline the process of working with GraphQL APIs.
35:07 - Exploring Postman’s Collaboration Features
Sean takes over to showcase Postman’s collaboration features. He demonstrates how to leave comments on specific parts of a request, explaining how team members can communicate and provide feedback directly within the Postman interface. They discuss the benefits of keeping API-related discussions contained within the workspace. This chapter highlights how Postman facilitates teamwork and communication in API development projects.
41:26 - Making Workspaces Public and Managing Environments
The hosts discuss how to make a Postman workspace public, allowing others to access and use the API collection. They touch on the importance of managing sensitive information like API keys when making workspaces public. Sean briefly explains Postman’s environment feature for managing variables across requests. This chapter covers important considerations for sharing API collections and managing configuration across different environments.
44:16 - Closing Thoughts and Resources
Anthony and Sean wrap up the stream by sharing additional resources for learning more about Postman and StepZen. They mention Postman’s regular streams and webinars, as well as StepZen’s online resources and GitHub samples. The hosts reflect on the key takeaways from the demonstration and express enthusiasm for the possibilities of using Postman with StepZen for API development. This final chapter provides viewers with next steps for further exploration of the tools and concepts discussed in the stream.