Studio Documentation
Guides and reference material for Studio.
About
What's New
OpenAPI 3.0 Support
OpenAPI 3.1 Support
OpenAPI 3.2 Support (Beta)
AsyncAPI Support
MCP Support
A2A Support
AI Features in Studio
- AI Features in StudioSwagger Studio provides AI-powered features that let you create, edit, and improve OpenAPI and AsyncAPI definitions using natural language, helping you to…
- Design with AISwagger Studio provides AI-powered features allowing you to create, edit, or enhance OpenAPI and AsyncAPI definitions. By describing an API in natural…
- Generating an API from CodeAI-powered features in Swagger Studio allow you to generate an API by uploading your existing source files rather than writing the definition by hand.…
- AI AgentsSwagger features AI-powered agents that allow you to automate common API tasks and guide you through complex workflows. These agents act as intelligent…
- Working with AI Agents: Best Practices, Privacy, and TroubleshootingThis topic provides guidance on getting the best results from AI agents in Swagger Studio, and answers common questions about data access, privacy, and…
- Swagger MCP ServerThe Swagger MCP Server lets you connect Swagger Studio to AI-powered assistants like Claude, GitHub Copilot, and Cursor. Once connected, you can search…
- Claude ConnectorSwagger Claude Connector allows Claude to work with your Swagger APIs and documentation so you can search, validate, fix, and publish them using…
- ChatGPT AppThe Swagger ChatGPT App allows ChatGPT to work with your Swagger APIs and documentation so you can generate, validate, fix, and publish them using…
- SmartBear VS Code ExtensionThe Swagger Model Context Protocol (MCP) Server lets AI assistants in Visual Studio Code (VS Code) work directly with your Swagger data. This topic…
Get Started
- Get StartedCheck out these tutorials and how-to's to get started with Swagger Studio:
- Creating an AccountIn order to start using Swagger Studio as well as other tools included in the Swagger solutions, you need to an SmartBear ID account. You can create it by…
- Basics of Swagger StudioThis tutorial provides a brief overview of Swagger Studio, and walks you through creating and publishing an API definition using Swagger Studio.
- Work with OthersThis page introduces Swagger Studio's access control and sharing. To complete the steps in this tutorial, you need to be an organization owner.
- OpenAPI 3.0 TutorialOpenAPI 3.0 is an open-source format for describing and documenting APIs. In this tutorial, we will write a simple API definition in the OpenAPI 3.0…
- Swagger (OpenAPI 2.0) TutorialThis tutorial describes what Swagger is and explains the Swagger syntax for various parts of your API definition file.
- OpenAPI How-ToThe swagger.io website is a great resource for learning how to document different kinds of API operations, parameters, requests, and responses. Check out…
- AsyncAPI How-ToAsyncAPI is an open-source specification for describing and documenting event-driven APIs. AsyncAPI 3.1 is a release of AsyncAPI 3 that adds bindings for…
Edit APIs
- Edit APIsThis section explains working with Swagger Studio to edit API files.
- Swagger Studio UI OverviewSwagger Studio lets you create, edit, and host OpenAPI and AsyncAPI definitions, collaborate with your team, and integrate them with third-party services.
- Swagger Studio Code EditorSwagger Studio provides an in-browser code editor that allows you to work with OpenAPI, AsyncAPI Model Context Protocol (MCP), and Agent2Agent (A2A)…
- Form Editor for OpenAPI DefinitionsSwagger Studio provides Form Editor for OpenAPI 2.0, 3.0, and 3.1 definitions, so that you can update your API information without having to understand…
- Draft EditorDraft Editor provides similar functionalities as Code Editor in Saved Mode, but allows you to keep your OpenAPI as a draft instead of creating a final API.
- Diff ModeWhen modifying an API in Code Editor, you can preview the implemented changes and compare them with the last saved definition. You can also review the…
- Interactive API DocumentationSwagger Studio generates interactive API documentation for your API definitions. Use it to explore the API endpoints, parameters, responses, and data…
- Searching Swagger StudioUse Swagger Studio Search to find APIs and domains by name, content, status, or other attributes. Anonymous users can search among all public definitions.…
- CORS Requirements for "Try It Out"Cross-origin resource sharing (CORS) is a security mechanism that enables a web page from one domain to access resources from another domain.
- Lazy LoadingSwagger Studio OpenAPI Editor and interactive API documentation use a technique called lazy loading to optimize loading of external $ref references, such…
Manage APIs
- Manage APIsCreate an API
- Creating a New APIYou can create APIs in Swagger Studio in several ways:
- Creating an API Custom TemplateAPI custom templates are API definitions that you can create for use as templates by your organization. Only organization owners can add them. Custom…
- Importing API DefinitionsYou can import your existing OpenAPI (2.0, 3.0), AsyncAPI (2.x.x, 3.0, 3.1), GraphQL, MCP, gRPC, or A2A definitions to Swagger Studio. JSON and YAML…
- Importing Postman CollectionsYou can add your existing Postman collections to Swagger Studio using the standard API importing features.
- Importing GraphQL API DefinitionsYou can upload your existing GraphQL API definitions to Swagger Studio by implementing the standard API importing features. The imported queries are then…
- Importing gRPC API DefinitionsYou can upload your existing gRPC API definitions to Swagger Studio by importing .proto files. The imported definitions are read-only and searchable in…
- Data Migration from StoplightIt is possible to transfer data from your Stoplight workspace into a Swagger organization, for use in Swagger Studio and Swagger Portal. This section…
- Migrating APIsYou can export OpenAPI definitions or projects from Stoplight to transfer these assets to your Swagger Studio instance.
- Exporting APIs from StoplightExport your resources from Stoplight before migrating them to your Swagger Studio instance. Stoplight allows you to generate an export of either OpenAPI…
- Importing APIs to Swagger StudioThe available methods you can use to move your APIs to Swagger Studio depend on where these APIs are stored.
- Migrating Markdown FilesYou can export Markdown files or projects from Stoplight to transfer these assets to your Swagger Portal instance.
- Exporting Markdown Files from StoplightMarkdown files are stored in an SCM system and are ready to be imported into Swagger Studio.
- Importing Markdown Files to Swagger PortalCreate a Portal product to manage your APIs and markdown files. See Provider View for detailed instructions.
- Migrating Spectral Style GuidesRulesets help ensure consistency, quality, and compliance with internal or industry standards across your API specifications.
- Forking an APIForking creates a copy of a specific version of an API in your account. For example, you can fork someone else’s API as a starting point for your own API.…
- Saving an API as a New APIYou can create an API by copying it from another API that exists in Swagger Studio. You can use this functionality to use some existing specification as a…
- Public and Private APIsAPI definitions in Swagger Studio can be public and private. Public APIs are visible to anyone, even to those who do not have a Swagger Studio account.…
- Swagger Contract TestingSwagger Studio now supports contract testing with Swagger Contract Testing's Bi-Directional Contract Testing feature. API designers and developers can use…
- Publishing an APIYou can publish your API definition when it is ready for production. Publishing is a way to show that the API is stable and that its endpoints can be…
- VersioningSwagger Studio allows you to manage multiple versions of your API or domain definitions. You typically start a new version when you need to add new API…
- Share APIsSwagger Studio allows multiple users to collaborate on the same API or domain. Depending on the assigned role, collaborators can edit API definitions…
- Share an APIYou can easily share your APIs with other users and teams on Swagger Studio. How you share an API depends on whether it is public or private and on the…
- CommentsSwagger Studio Code Editor supports comments, enabling you to share your thoughts and discuss ideas with other users. You can use comments as tickets that…
- Custom Branding for API DocumentationOrganizations can add custom branding to their API documentation on Swagger Studio. The branding options include a custom logo and header color that will…
- Comparing and Merging API VersionsSwagger Studio has a built-in diff tool that lets you compare and merge API definitions. You can:
- Download API Definitions from Swagger StudioSwagger Studio lets you download the API definition of any API or domain in the YAML or JSON format.
- Transferring API OwnershipYou can transfer APIs to organizations in Swagger Studio. The user is an owner in both organizations, so they can revert the API ownership if needed.
- Renaming APIsYou must be the API owner or a designer to rename an API.
- Generating CodeSwagger Studio lets you generate server and client code based on API definitions to help you get your API servers and clients up and running quickly. You…
- Generating a Server StubWith Swagger Studio, you can easily generate a server stub (an API implementation stub) for Node.js, ASP.NET, JAX-RS, and other servers and frameworks.…
- Generating a Client SDKSwagger Studio lets you generate client SDKs for APIs in JavaScript, Java, C#, Objective C, Swift, Android, and many other languages. A client SDK…
- Code Generation OptionsSwagger Studio lets you customize code generation options for server stubs and client SDKs for individual APIs. Each language or framework has specific…
- Generating MCP ServerSwagger Studio allows you to generate an MCP server for the API definitions stored in your collection. You can create and download the MCP server file…
- Deleting APIsUser can delete their own API definitions at any time, but organization-owned APIs can only be deleted by the organization owners. When an API is deleted,…
- Swagger Studio Vendor ExtensionsSwagger Studio supports the following vendor extensions for OpenAPI.
API Governance
- API GovernanceAPI Governance helps ensure that your API definitions comply with your company’s API style guide. Swagger Studio provides various rules to check the…
- Spectral Style GuidesCreate or import Spectral rulesets in Swagger Studio and execute them in your API definitions for easy linting and validation. This functionality ensures…
- Custom Rules for API GovernanceOrganizations can add custom rules for API Governance to validate OpenAPI definitions for compliance with API design guidelines. These rules allow you to…
- OWASP Top 10A set of rules to help enforce the OWASP Top Ten security guidelines. These guidelines are defined in OWASP Top 10 and the rules to help enforce them are…
Domains
- DomainsA domain is a library of common components – such as parameters, responses, and data models – that are used across multiple API definitions. API…
- OpenAPI ComponentsOpenAPI domains can contain the following component types:
- AsyncAPI ComponentsAsyncAPI components are described in the AsyncAPI specification.
- Creating a DomainYou can create a new domain from scratch, and then add content to it, or you can fork an existing domain like you fork an API.
- Refer to a DomainAPIs can reference shared components from domains by using the $ref keyword. Domain references have the following format:
- Manage DomainsYou can manage domains in the same way you manage API definitions. For example, you can:
- Transferring Domain OwnershipYou can transfer domains to other organizations in Swagger Studio. This operation cannot be reversed unless the new owner has goodwill to return the…
- Rename DomainsA domain can be renamed by its owner only.
- OpenAPI 3.1 Domain ExampleBelow is an example of an OpenAPI 3.1 domain definition demonstrating various types of domain components.
- OpenAPI 3.0 Domain ExampleBelow is an example of an OpenAPI 3.0 domain definition demonstrating various types of domain components.
- OpenAPI 2.0 Domain ExampleBelow is a sample OpenAPI 2.0 domain definition demonstrating various types of domain components.
- AsyncAPI Domain ExampleBelow is an example of an AsyncAPI domain definition demonstrating various types of domain components.
Integrations
- IntegrationsSwagger Studio integrates with other development and API-related tools, which allows you to connect your API definitions to your existing toolset. For…
- Sync API Definitions Between Source Control and Swagger StudioSwagger Studio integrates with many source control systems allowing you to synchronize your API definitions with an external repository. This integration…
- Amazon API Gateway IntegrationAmazon API Gateway allows developers to create, publish, monitor and secure APIs at any scale. Using API Gateway, you can map HTTP endpoints to various…
- Amazon API Gateway Lambda SyncAWS Lambda is Amazon’s compute service that lets you run code in response to HTTP requests. AWS Lambda along with Amazon API Gateway allow you to…
- API Auto MockingThe API Auto Mocking integration creates and maintains a semi-static mock of your API based on the responses and examples defined in your OpenAPI 3.1,…
- Apigee Edge IntegrationApigee Edge is an API management platform that allows developers to secure, manage, scale and analyze their APIs and API traffic. The Swagger Studio…
- Azure API Management IntegrationMicrosoft Azure API Management allows developers to publish and maintain APIs in the Azure cloud. Swagger Studio integrates with Azure API Management,…
- Azure DevOps Services IntegrationThe Azure DevOps Services integration lets you synchronize your API definition, auto-generated server code, or client SDK with an existing Git repository…
- Bitbucket Cloud SyncThis guide is for Bitbucket Cloud (bitbucket.org). If you use self-hosted Bitbucket Server, see Bitbucket Server Sync.
- Bitbucket Server SyncBitbucket Server Sync integration is deprecated as of June 17, 2026.
- GitHub SyncThis guide describes how to integrate with GitHub.com. If you use self-hosted GitHub Enterprise Server, see GitHub Enterprise Server Sync.
- GitHub Enterprise Server SyncThis guide is for self-hosted GitHub Enterprise Servers. If you use GitHub.com, see GitHub Sync.
- GitHub Push (Legacy)Swagger Studio Integrations
- GitLab SyncYou can use the GitLab integration settings to synchronize your API definition, auto-generated server code, or client SDK with an existing repository on…
- GradleA simple gradle plugin to integrate Swagger Studio hosting of OpenAPI/Swagger definitions with a gradle build process, using the Swagger Studio API.
- Swagger Studio Plugin for IntelliJ IDEASwagger Studio has a plugin for IntelliJ IDEA that lets you view and edit your OpenAPI definitions stored in Swagger Studio directly from the IDE. You can…
- Visual Studio CodeThe SwaggerHub extension lets you view and edit your OpenAPI definitions stored in Swagger Studio directly from Visual Studio Code. You can access your…
- MavenA simple Maven plugin to access Swagger Studio hosting of OpenAPI/Swagger definitions within a Maven build process, using the Swagger Studio API.
- Swagger ExploreSwagger Explore is a tool that allows you to interact with REST APIs and Kafka services.
- Swagger PortalSwagger Portal is a web application used to create and maintain product webpages, known as portals. Portals showcase products and connected documentation…
- WebhooksA webhook sends a POST request to a specific URL every time an API is saved or published in Swagger Studio. You can use webhooks to notify external…
- Copy IntegrationsSwagger Studio integrates with other development and API-related tools. If an API has several versions, you can configure the integrations for different…
Resource Access
- Manage Resource AccessThis section of the Swagger Studio documentation describes how to manage access to resources:
- Resource RolesFor an overview of resource sharing and user roles, see: Work with Others.
- Work With OrganizationsLearn how to create and manage organizations in Swagger Studio.
- Manage an Organization in Swagger StudioAccounts typically have only one organization, which is created during the account setup.
- Manage Member RolesThis topic describes how to add, update, and delete roles of Swagger Studio users. For an overview of roles, click here.
- Organization Settings Related to PermissionsTo view or change Resource Access preferences:
- External IdP Support for Portal ConsumersSwagger Studio supports external identity provider (IdP) integration for Swagger Portal consumers. It allows customers to use their own IdP to…
- ProjectsOrganizations can organize their APIs and domains into projects and control member access to individual projects. An organization can have any number of…
- Create ProjectsProjects always belong to an organization. To create a project, you need to be an organization owner.
- Add and Delete APIs and Domains From ProjectsA project is a group of an organization’s APIs and domains. A single API or domain can belong to multiple projects.
- Add and Delete Users in ProjectsAn organization owner can change the project members – users and teams. These users and teams must belong to the organization that owns the project. For…
- Share ProjectsYou can send a project link to your co-workers so that they can quickly access that project in Swagger Studio.
- Delete ProjectsOrganization owners can delete projects that are no longer needed.
- TeamsOrganization owners can set up teams to group users into teams. Teams help you easily control access to API definitions for multiple users at once:…
- Create TeamsOrganization owners can create teams in their organizations.
- Add and Remove Users in TeamsThe organization owner can change team members at any time.
- Manage Resource AccessAn organization owner can manage the resources (APIs, domains, projects, Portal products) that the team has been assigned. This information is displayed…
- Delete TeamsAn organization owner can delete teams that exist in that organization. Deleting a team revokes all API collaboration permissions assigned to this team.
- Audit LogsOrganization owners can download the audit log to review the changes made to the organization, its APIs and domain within the last 90 days. The audit log…
Account Settings
- Account SettingsThis section of the documentation describes how you can update your Swagger Studio account details like username, password and email address.
- User Account SettingsYou can update your Swagger Studio account details like: first name, last name, phone, and company.
- Rename Your AccountYou can change your Swagger Studio username at any time. If you use API auto-mocking, the mock URLs will also be changed to reflect your new username.
- Link to GitHub AccountTo log in to Swagger Studio, you can use a Swagger Studio or GitHub account. You can sign up with a Swagger Studio account and then link it to your GitHub…
- Delete Your AccountYou can delete your Swagger Studio account at any time. Deleting your account immediately deletes all your APIs and domains. Any organizations where you…