API Design Generation with Blackbird

To effectively utilize Blackbird for API management, you will need to add your APIs to your organization’s catalog. Once your APIs are cataloged, you can take advantage of several key features, including creating mock instances, generating code based on your spec, testing your code, and deployment instances.

Add an API specification

If you don't have an existing API, you can add one using the Blackbird UI. On the Dashboard page, choose the Add API button and select one of the following:

• Create API – Use an AI chatbot to describe the type of API you want to create and then generate a specification based on your request. For example, you could provide the following prompt for a payment processing API: I want to create a new API for processing payments. Use OpenAPI 3.0.1. The service should have paths and operations related to accepting user payment requests, processing payments, and handling payment errors.

• Third Party API – Use an external API to start designing your API with pre-built functionality. For example, use OpenAPI, Zoom API, or Google Analytics API.

Create a new API to store in the Blackbird Catalog

To create a new master API in the Blackbird Catalog, run the API create command.

Update an existing API in the Blackbird Catalog

To update an existing master API in the Blackbird Catalog, run the API update command.

List all APIs in the Blackbird Catalog

To get a list of available APIs that you can use for mocking, enter the list command.

Delete an API from the Blackbird Catalog

To remove an api from the Blackbird Catalog you can use the api delete command.

When deleting an API, you will be asked whether associated instances should be deleted as well. If you choose to delete the instances, the associated instances will be removed from the system. Otherwise, the instances will remain in the system, while the API will be removed from the catalog.