ChatGPT App
The Swagger ChatGPT App allows ChatGPT to work with your Swagger APIs and documentation so you can generate, validate, fix, and publish them using natural-language prompts. This topic explains what the Swagger ChatGPT App is, how to set up the connection, and how to work with your APIs through ChatGPT.
The Swagger ChatGPT App connects to the Swagger MCP Server, a remote Model Context Protocol (MCP) server that SmartBear hosts, so you can connect ChatGPT without running or maintaining a server yourself. It exposes Swagger tools to ChatGPT, such as searching your API catalog, retrieving an API definition, scanning an API against governance rules, and creating portal documentation. It supports both read and write actions.
The Swagger ChatGPT App is available on the Plugins page in ChatGPT, where it is listed as swagger. It enables a sign-in through OAuth 2.0 with your SmartBear account. No additional account is needed.
Prerequisites for Swagger ChatGPT App
A Swagger account with access to the Swagger APIs and documentation you want to work with.
A ChatGPT account with access to plugins.
Set up Swagger ChatGPT App
To add the Swagger ChatGPT App to your ChatGPT account, do the following:
In the ChatGPT sidebar, select Plugins.
In the Search plugins field, enter swagger.
In the search results, select the Swagger app.
Click Install plugin.
On first connection, you are redirected to the SmartBear sign-in page in your browser.
Sign in with your SmartBear credentials and approve the requested access. After authorization, the token is stored and renewed automatically.
Work with the Swagger ChatGPT App
After adding the Swagger ChatGPT App, use it in any chat by tagging it in your message. To do this:
In the message box, select the + (Add files and more) button.
In the menu that opens, select swagger. You can also type to search for it.
The swagger tag is added to your message.
Enter your request in plain language and send the message.
ChatGPT selects the Swagger tools it needs to complete your request. For example, you can enter a request such as:
Create an API for a train booking system, validate it against governance rules, add documentation, and publish it to a developer portal.
For this request, ChatGPT uses tools such as Swagger: Create API from Prompt to generate the API definition, Swagger: Scan API Standardization to check it against governance rules, Swagger: Standardize API to apply fixes, and Swagger: Create Documentation Page to publish the documentation to a portal.
Swagger ChatGPT App FAQ and troubleshooting
Do I need to install or host a server to use Swagger ChatGPT App?
No. The Swagger ChatGPT App connects to a remote MCP server that SmartBear hosts. You add it from the Plugins page in ChatGPT without running or maintaining a server yourself.
The sign-in fails or ChatGPT does not connect. What should I check?
Make sure that you sign in with your SmartBear credentials and approve the requested access on the SmartBear sign-in page. Also verify that your SmartBear account has access to Swagger.