API Quickstart

In this tutorial, we'll be adding an entry to our API catalog using the Blackbird CLI.

Before you get started

This tutorial assumes you have already have the Blackbird CLI installed. If not, please download the Blackbird CLI by following the Getting Started guide. If you haven't done that already, you should do that now.

Once we have the Blackbird CLI downloaded, please make sure to login.

1. Creating an API

For the purposes of this tutorial we are going to use the sample simpleapi.yaml file.

Once the file is downloaded, we are going to add an API to our catalog using the api create command.

2. Listing an API

Once our API is created, we can view it using the api list command.

3. Using our API

Now that we have an API in our catalog, there are a few different Blackbird tools that we can now use.

The next step in our tutorial should be to mock our API. Please follow the Mocking Quickstart Guide.

4. Deleting our API

Once we are done using our API, we can delete it from our catalog using the api delete command.

This command will also ask us if we should delete all deployments associated with our API as well.