Swagger Studio Integration

The Swagger Studio client provides comprehensive API and Domain management capabilities through SwaggerHub Registry. Access to these features requires authentication with a SWAGGER_API_KEY.

Available Tools

Swagger Studio API Tools

search_apis_and_domains

• Purpose: Search for APIs and Domains in Swagger Studio using the comprehensive /specs endpoint and retrieve metadata including owner, name, description, summary, version, and specification.
• Returns: List of API and Domain specifications matching the search criteria.
• Use case: Discover existing APIs and domains for integration or reference.
• Parameters:

get_api_definition

• Purpose: Fetch a resolved API definition from Swagger Studio based on its owner, API name, and version.
• Returns: Complete OpenAPI specification for the requested API.
• Use case: Retrieve the specified API definitions for integration, testing, or documentation purposes.
• Parameters:

create_or_update_api

• Purpose: Create a new API or update an existing API in SwaggerHub Registry for Swagger Studio. The API specification type (OpenAPI, AsyncAPI) is automatically detected from the definition content. If an API with the same owner and name already exists, it will be updated; otherwise, a new API will be created.
• Returns: API metadata including owner, name, version (always 1.0.0), SwaggerHub URL, and operation type ('create' or 'update'). HTTP 201 indicates creation, HTTP 200 indicates update.
• Use case: Programmatically create new APIs from OpenAPI/AsyncAPI specifications, update existing API definitions with new versions of the specification, or migrate APIs into Swagger Studio.
• Parameters:

create_api_from_template

• Purpose: Create a new API in SwaggerHub Registry using a predefined template. This endpoint creates APIs based on existing templates without requiring manual definition content.
• Returns: API metadata including owner, name, template used, SwaggerHub URL, and operation type ('create' or 'update'). HTTP 201 indicates creation, HTTP 200 indicates update.
• Use case: Quickly bootstrap new APIs from organization templates, ensure consistency across API projects, or start new API development with pre-configured standards.
• Parameters:

scan_api_standardization

• Purpose: Run a standardization scan against an API definition using the organization's governance and standardization configuration. Validates OpenAPI/AsyncAPI definitions against configured rules and style guides.
• Returns: Standardization result with a list of validation errors and warnings. Each error includes severity level, rule name, and location information.
• Use case: Validate API definitions against organization standards before publishing, ensure compliance with API governance policies, and identify design inconsistencies early in the development process.
• Parameters:

create_api_from_prompt

• Purpose: Generate and save an API definition based on a natural language prompt using SmartBear AI. This tool automatically applies organization governance and standardization rules during API generation. The specType parameter determines the format of the generated definition.
• Returns: API metadata including owner, name, specType, version (from X-Version header if available), SwaggerHub URL, and operation type ('create' or 'update'). HTTP 201 indicates creation, HTTP 200 indicates update.
• Use case: Rapidly create APIs from natural language descriptions (e.g., "Create a RESTful API for managing a pet store with endpoints for pets, orders, and inventory"), generate API prototypes for proof-of-concept work, or bootstrap new API projects with AI assistance while ensuring compliance with organization standards.
• Parameters:

standardize_api

• Purpose: Standardize and fix an API definition using AI to ensure compliance with governance policies. Scans the API definition for standardization errors and automatically fixes them using SmartBear AI. If errors are found, they will be sent to SmartBear AI to generate a corrected definition, which is then saved back to the registry.
• Returns: Standardization result including a message, the number of errors found, and the fixed definition if successful. Also includes details about each error (description, line number, severity).
• Use case: Automatically fix API definitions that fail standardization scans, ensure governance compliance in existing APIs, or clean up imported/legacy API definitions to meet current organization standards.
• Parameters:

Configuration

To use Swagger Studio tools, you need to configure the SWAGGER_API_KEY environment variable with your Swagger API token.

Common Use Cases

1. API Discovery: Use search_apis_and_domains to find existing APIs in your Swagger Studio.
2. API Integration: Retrieve specific API definitions with get_api_definition for development or testing purposes.
3. API Creation: Create new APIs using create_or_update_api with custom definitions, create_api_from_template using organization templates, or create_api_from_prompt with natural language descriptions powered by AI.
4. API Governance: Validate API definitions against organization standards using scan_api_standardization to ensure compliance with governance policies, then use standardize_api to automatically fix any violations.
5. AI-Powered API Development: Leverage create_api_from_prompt to rapidly prototype APIs from natural language, then use standardize_api to ensure they meet your organization's standards.