API Templates: How to Build a GraphQL API in 3 Easy Steps
We are delighted to announce the launch of StepZen API Templates — the simplest and fastest way to build a GraphQL API that connects REST, SOAP, and GraphQL APIs, SQL and NoSQL databases, or any other backend data sources into a single unified endpoint that developers can query to get the data they need.
API Templates are pre-made GraphQL schemas configured with schema types, queries, and connections to backend data sources. Browse the API Templates Gallery or access them in the GitHub repository: https://github.com/steprz/stepzen-schemas. Starting with the StepZen CLI to import one or more templates from the GitHub repository, it takes only minutes to create a GraphQL API from a whole range of popular APIs.
Your GraphQL endpoint live in minutes
The stepzen import
and stepzen start
CLI commands work together and let you first import a template from the repository, then upload and deploy the GraphQL API right away so that you work with a live endpoint as you extend and customize it. Here's Carlos to show us how:
Building blocks simplify and speed GraphQL API development
Whether enabling static and dynamic interactions with APIs on Jamstack sites or building sites and apps with other web technology, today’s developer is connecting and orchestrating a complex network of data sources - from APIs to databases. All have different interfaces, languages, protocols, and authentications; all have varying levels of good, bad, and ugly documentation for you to explore and hopefully learn how to connect and effectively work with the data.
When it comes to fetching and consuming data, there are many reasons to believe in GraphQL as the right technology to simplify frontend and back-end developer workflows. API Templates are building blocks that give you a jumpstart on creating your GraphQL API.
- You are productive in minutes. You don’t need to learn how to build a GraphQL server, understand resolvers, or the details of GraphQL stitching to build and deliver a GraphQL API that connects all the data you need into an easy-to-query graph.
- API Templates come pre-configured with connections to specific backend data sources. Some are open and can be used right away. For those that require keys or credentials, the
stepzen import
CLI prompts you to provide the relevant information. The CLI uses your responses to write the configuration file (config.yaml) , which securely saves the keys and other credentials that StepZen needs to access the backends. - StepZen is a managed service, meaning no infrastructure headaches for developers at runtime. Even at build-time, thanks to a built-in mock service, you use the
stepzen start
command to deploy and run your API as you design it, making iteration and testing easy. - After you import a template, you have laid down your optimized project structure, and have a solid starting point to extend and customize the schema files, the specifications for backend connectors, the configurations, the linking of types, and more.
- Each folder in the GitHub repository is self-contained and provides the information about what's needed regarding authentication, keys, IDs, and so on for the data sources the template integrates.
- You have the flexibility to mix and match schemas as needed depending on your domain and use case.
Where to go from here
We continue to add to our API templates ecosystem, and if there's one you'd like to have or an extension to an existing one, we'd love to hear your ideas.
If you're already signed up for StepZen, there's nothing you need to do to start building with templates. Not yet signed up? Try it free here https://stepzen.com/signup. For documentation, check out the GitHub repository and the StepZen docs.
We look forward to seeing what you build.