Quick Start Guide

Catalyst ZEST revolutionizes the API development life cycle with an innovative approach. Your simple sketch of the API in the ZSPEC file streamlines the handling of repetitive tasks and allows you to concentrate on developing the business logic. This not only increases productivity but also elevates the quality of your APIs. To unlock these advantages, let’s walk you through the workflow in Catalyst ZEST.

Create a Catalyst Project

Start by logging in to the Catalyst Console and creating a new project to tap into Catalyst ZEST.

Navigating ZEST Components

Spec Studio - Craft Your API Specifications

In the Spec Studio, compose a ZSPEC file for your API, encompassing all your requirements. Refer to our help pages for guidance on creating a detailed ZSPEC. After completion, upload the file to ZEST.

Build Your Application on Cloud

Use the boilerplate codes generated in Spec Studio for Catalyst AppSail, develop your code by simply adding the business logic to the generated boilerplate code, and deploy your application on the cloud. If you want to create an API from scratch, the boilerplate codes can be downloaded in Java Spring Framework. You can also download the SDKs from Spec Studio.

Automate your API Automation Testing

Fill in the domain, version, and authentication details, then utilize the same spec to run automation. It automatically generates test cases, runs validations, and downloads detailed reports of them. You can also run automation for your existing APIs or Catalyst functions by simply uploading the respective ZSPEC files to ZEST.

Docs Builder - Design your Help Documents

In Docs Builder, upload the Format XML file to design a menu that aligns with your specific requirements. Follow our help pages to write the XML format. Download the generated documents and upload the zip to Web Client Hosting of Catalyst Cloud Scale. Serve it on a website to provide comprehensive documentation for your clients. There you have it: an end-to-end API lifecycle management made easy with Catalyst ZEST. Experience the comfort of crafting, building, testing, and documenting your APIs with just a few clicks.

Here is how the document hosted in Catalyst looks like.

Click here to know more about the various components of ZEST.