The Blackbird VS Code Extension is a powerful tool designed to enhance your development workflow by integrating Blackbird's API, mock, and deployment management capabilities directly into Visual Studio Code. This extension provides a seamless experience for managing your Blackbird resources, interacting with APIs, and monitoring your organization’s subscription status.
Features
1. Tree View for APIs, Mocks, and Deployments
APIs: View and manage your APIs directly from the tree view.
Mocks: Access and manage mock deployments with ease.
Deployments: Monitor and manage your application deployments.
Login Prompt: If you are not logged in, the tree view will prompt you to log in to Blackbird.
2. Commands
The extension provides a variety of commands to manage your Blackbird resources:
Authentication:
Login to Blackbird: Log in to your Blackbird account.
Logout of Blackbird: Log out of your Blackbird account.
APIs:
Create: Create a new API.
Update: Update an existing API.
Delete: Delete an API.
Review: Review an API (requires GitHub Copilot Chat).
Mocks:
Create: Create a new mock deployment.
Update: Update an existing mock deployment.
Copy Mock URL: Copy the URL of a mock deployment.
Delete: Delete a mock deployment.
General:
Open in Browser: Open the selected resource in your default browser.
Switch Organization: Switch between organizations in Blackbird.
Refresh: Refresh the tree view to fetch the latest data.
3. Status Bar Integration
Displays the name of your current organization.
Shows subscription details, including status, plan, and validity period.
Alerts you if your subscription is inactive, with a link to renew or upgrade.
4. File Watcher for OpenAPI Files
Automatically detects changes in OpenAPI files (.yaml, .yml, .json) and updates the context accordingly.
5. Chat Integration
If the GitHub Copilot Chat extension is installed, the Blackbird extension integrates with it to provide an interactive chat participant for API-related queries.
6. CLI Integration
The extension checks for the presence of the Blackbird CLI and sets the context accordingly. If the CLI is not found, an error message is displayed.
Installation
Install the extension from the Visual Studio Code Marketplace.
Ensure you have the Blackbird CLI installed and accessible in your system's PATH.
Usage
Login: Use the Login to Blackbird command to authenticate.
Explore Resources: Navigate through the tree view to manage APIs, mocks, and deployments.
Manage Resources: Use the context menu or commands to create, update, delete, or review resources.
Monitor Subscription: Check the status bar for your organization and subscription details.
Interact with OpenAPI Files: Edit OpenAPI files in your workspace, and the extension will automatically update the context.
