OpenAPI Integration

The most comprehensive OpenAPI implementation in any HTTP client.

5-Minute Quick Start

Start Here

Get up and running with OpenAPI in Tigrister in just a few steps.

1
Create New Project

Click "New Project" in the sidebar. Select "Import OpenAPI" tab.

2
Import a Spec

Paste this URL and click Import:
https://petstore3.swagger.io/api/v3/openapi.json

3
Start Testing

Select a module (pet, store, user). Click an endpoint. Hit Send!

That's it! You now have a fully functional API project. Any changes you make sync back to the OpenAPI spec automatically.

What is OpenAPI?

OpenAPI (formerly Swagger) is the industry standard for describing REST APIs. It defines your API's endpoints, parameters, request bodies, responses, security, and more in a single specification file.

Tigrister's Approach

Unlike other tools that treat OpenAPI as a simple import/export feature, Tigrister deeply integrates OpenAPI with its Project system. Your project IS an OpenAPI spec, and every change syncs both ways automatically.

Bi-Directional Synchronization

This is what makes Tigrister unique. Changes flow in both directions:

Project

Modules, Endpoints

Sync
{ }
OpenAPI Spec

YAML / JSON

1Project to Spec
  • Add an endpoint in Tigrister
  • Edit request parameters
  • Set up authentication
  • Configure assertions

OpenAPI spec updates automatically

2Spec to Project
  • Edit YAML/JSON in designer
  • Add paths in visual editor
  • Modify schemas
  • Update security schemes

Project structure updates automatically

Supported Versions

Swagger 2.0

Auto-converted to 3.0.3 on import

OpenAPI 3.0.x

Full support (3.0.0 - 3.0.4)

OpenAPI 3.1.x

Full support (3.1.0 - 3.1.2)

OpenAPI 3.2.0

Latest version supported

Version Conversion

Tigrister can convert between OpenAPI 3.x versions (3.0 ↔ 3.1 ↔ 3.2). Swagger 2.0 specs are automatically upgraded to OpenAPI 3.0.3 on import. Features not available in older versions (like webhooks) are handled gracefully.

How It Works

1

Create or Import a Project

Start fresh or import an existing OpenAPI/Swagger spec.

2

Work in Your Preferred Mode

Use Area mode for testing requests, or Designer mode for API design.

3

Everything Stays in Sync

Changes in any mode automatically update the underlying OpenAPI spec.

4

Export Anytime

Export your spec as YAML or JSON, in any supported version.

Key Concepts

OpenAPI TermTigrister EquivalentDescription
tagsModulesLogical groupings of endpoints
paths + operationsEndpointsAPI endpoints (GET /users, POST /orders)
serversServersBase URLs for the API
components/schemasSchemasReusable data models
securitySchemesSecurity SchemesAuth methods (API key, OAuth, etc.)
webhooksWebhooksOutbound API calls (3.1 only)

Tigrister Extensions

Tigrister adds custom extensions to preserve app-specific data in your OpenAPI spec:

x-tigrister-project-id- Links spec to project
x-tigrister-version- Tigrister format version
x-tigrister-module-id- Links tag to module
x-tigrister-endpoint-id- Links operation to endpoint
x-tigrister-env-id- Links server to environment
x-tigrister-env-name- Environment name for server
x-tigrister-assertions- Test assertions for endpoints
x-tigrister-auth- Auth configuration per endpoint
x-tigrister-enabled- Enabled state for endpoints

Compatibility

These extensions follow the OpenAPI specification's extension format (x-*). Other tools will ignore them, so your exported specs remain fully compatible.

Why Choose Tigrister for OpenAPI?

See how Tigrister compares to other popular tools for OpenAPI workflows:

FeatureTigristerPostmanInsomnia
Import OpenAPI specsYesYesYes
Export OpenAPI specsYesYesYes
Bi-directional syncYesOne-wayOne-way
Visual spec designerYesNoNo
Code editor with validationYesLimitedNo
Swagger UI previewBuilt-inNoLimited
OpenAPI 3.2 supportYesNoNo
Version conversion2.0 → 3.x, 3.x ↔ 3.xImport onlyLimited
Project IS the specYesNoNo