> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# SwaggerHub plugin

> Registry for API definitions, for storing, validating, comparing and publishing OpenAPI specs, domains and templates.

Use **SwaggerHub** through Corsair: one client, typed API calls.

**SwaggerHub authenticates with one API key**, sent in the `Authorization` header with **no `Bearer` prefix**. Create a key on your account at app.swaggerhub.com under Settings, then API Key. There is no per-account host and no second credential.

Things to know before you call:

* **Every spec is addressed by `owner/api/version`**, and the owner and name are **case-sensitive**. Each segment is URL-encoded, so a version like `feature/branch` survives.
* **`GET /apis` and `GET /domains` answer a 303** to `/specs`, so `specs.list` is the listing route this plugin uses. `apis.list` reads one owner's APIs.
* **Saving takes the definition itself as the body**, not a wrapper. `format: 'yaml'` is the default; `format: 'json'` sends the JSON media type.
* **Defining the version twice.** For OpenAPI and AsyncAPI the version is read from `info.version`, so `version` is optional on save. GraphQL and MCP need it.
* **A save answers 409 on a published version** unless `force` is set, and a save replies with no body, so the plugin reports what it wrote.
* **`specs.validate` saves nothing.** It is the structural check to run before a save, and it returns findings with line and column positions.
* **`comments.list` answers a bare array**, and a 204 when the version has no comments. A 204 reads as `{ comments: [], empty: true }`.
* **`apis.compare` posts a definition** and answers a bare array of differences. Nothing is stored.
* **`projects.update` replaces the project**, so a collection left out is cleared. The plugin always sends all three collections.

**What you get:**

* 44 typed API operations

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/swaggerhub better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/swaggerhub better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/swaggerhub better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/swaggerhub better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { swaggerhub } from '@corsair-dev/swaggerhub';

export const corsair = createCorsair({
	plugins: [
		swaggerhub(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the SwaggerHub API key before the first call: `pnpm corsair setup --plugin=swaggerhub --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> swaggerhub()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'swaggerhub',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**List API specs**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.swaggerhub.api.specs.list({ limit: 20 });
```

**Save a definition**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.swaggerhub.api.apis.save({ owner: 'your-org', api: 'petstore', definition: 'openapi: 3.0.0
info:
  title: Petstore
  version: 1.0.0
paths: {}
' });
```

See the full list on the [API](https://docs.corsair.dev/plugins/swaggerhub/api.md) page.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/swaggerhub/api.md)
>
> Every `swaggerhub.api.*` operation with input and output types.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.