Exporting Your Spec

Export Options

Export your project as a standard OpenAPI specification file. Share it with your team, import into other tools, or use it for documentation generation.

Output Formats

Export in your preferred format:

YAMLHuman-readable
openapi: '3.0.3'
info:
title: My API
version: '1.0.0'
  • • Easy to read and edit
  • • More compact than JSON
  • • Supports comments (in some tools)
JSONUniversal format
{
"openapi": "3.0.3",
"info": {
"title": "My API",
"version": "1.0.0"
}
}
  • • Works with any programming language
  • • Strict, unambiguous syntax
  • • Better for programmatic access

Version Selection

Export to different OpenAPI versions:

OpenAPI 3.0.3Recommended

Widest compatibility. Works with most OpenAPI tools, code generators, and documentation platforms.

OpenAPI 3.1.0

Full JSON Schema 2020-12 support, webhooks, and nullable type arrays.

Version Conversion

When converting from newer to older versions, some features may be modified:

  • webhooks - Removed (3.0 doesn't support webhooks)
  • type: ["string", "null"] - Converted to nullable: true
  • • JSON Schema 2020-12 features - Converted to draft-07 for 3.0

How to Export

1

Open the Project

Navigate to your project in the sidebar and open it.

2

Switch to Designer Mode

Click the "Designer" toggle at the top to enter Designer mode.

3

Use Code Editor

Switch to "Editor" mode to see the raw spec. Select your format (YAML/JSON).

4

Copy or Save

Copy the content to clipboard, or save it to a file.

Export Features

Tigrister provides intelligent export with version detection and conversion warnings.

3.1 Feature Detection

Tigrister automatically detects if your spec uses 3.1-only features:

  • Webhooks (top-level)
  • Type arrays ["string", "null"]

If detected, exporting to 3.0.3 will show conversion warnings.

Conversion Warnings

When exporting with version conversion, Tigrister returns warnings:

{
content: "openapi: 3.0.3...",
warnings: {
hasWebhooks: true,
unsupportedFeatures: [...]
}
}

About Tigrister Extensions

Exported specs may contain Tigrister-specific extensions (x-tigrister-*). These preserve app-specific data like assertions and custom auth configs.

Keep Extensions

Extensions are preserved in the export. Other tools ignore them (per OpenAPI spec), but they'll be restored if you re-import.

Good for: Backup, team sharing

Clean Export

If you want a completely clean spec without any extensions, you can manually remove the x-tigrister-* fields.

Good for: Public documentation

What You Can Do With Exported Specs

Documentation

Use with Swagger UI, ReDoc, or other documentation generators to create beautiful API docs.

Code Generation

Generate server stubs and client SDKs using OpenAPI Generator or similar tools.

API Gateways

Import into API gateways like Kong, AWS API Gateway, or Azure APIM to configure routing and policies.

Testing Tools

Import into Postman, Insomnia, or other API clients. Use for contract testing with tools like Prism.

Which Version Should I Export?

?

Need maximum tool compatibility?

→ Export as OpenAPI 3.0.3 - works with 99% of tools

?

Using webhooks or full JSON Schema?

→ Export as OpenAPI 3.1.0 - required for these features

?

Generating server code or client SDKs?

→ Check your generator - most work best with 3.0.3

?

Re-importing into Tigrister later?

→ Keep extensions and use any version - all are supported

CI/CD Integration Patterns

Integrate your OpenAPI spec into your development workflow:

GitHub ActionsValidate on PR
- name: Validate OpenAPI
run: npx @redocly/cli lint openapi.yaml
Pre-commitGenerate Clients
- repo: local
hooks:
- id: openapi-codegen
entry: openapi-generator-cli generate -i openapi.yaml
DeployPublish to Gateway
# Deploy spec to AWS API Gateway
aws apigateway import-rest-api \
--body fileb://openapi.json \
--fail-on-warnings

Tip: Use Clean Export for CI/CD

When exporting for automated pipelines, use clean export to remove Tigrister extensions. This ensures compatibility with all downstream tools.

Best Practices

Version Control

Store exported specs in Git alongside your code. Track API changes over time.

Validate Before Sharing

Tigrister validates your spec in real-time. Ensure there are no errors before exporting.

Choose the Right Version

Use 3.0.3 for maximum compatibility, 3.1.0 for latest features.

Include Examples

Add example values to your schemas - they make generated docs much more useful.