v1.0.0 • Swagger Weaver
Welcome

Swagger Weaver Docs

The ultimate tool for crafting production-ready OpenAPI specifications. Design, document, and generate visually stunning APIs with ease.

Core Concepts

Swagger Weaver uses a layout-first approach to API design. The interface handles the complexity of YAML syntax while giving you full control over the specification.

Editor Workspace

The central hub where you define paths, logical components, and global configurations.

Live Preview

Real-time Swagger UI rendering of your specification as you type.

Cloud Sync

Seamless integration with Google Drive for saving and loading your work.

Export Ready

One-click export to standard YAML or JSON for CI/CD pipelines.

Endpoint Management

Endpoints are the heart of your API. Weaver makes managing them intuitive.

    Smart Paths

    Define paths like `/users/{id}`. The editor automatically detects path parameters and prompts you to configure them.

    Deep Duplication

    Need a similar endpoint? Use the Duplicate action to clone an endpoint with all its parameters, bodies, and responses.

Request Body Control

Define complex payloads with a visual builder or raw code editors.

Advanced Field Options

Toggle "Show Advanced" in the field editor to access detailed properties:

Default Value
Example
Deprecated
Read Only
Write Only
Custom Format

Supported Content Types

application/json
multipart/form-data
application/x-www-form-urlencoded
application/octet-stream
text/plain

Reusable Schemas

Don't repeat yourself. Define models once and use them everywhere.

Linking Schemas

When defining a Request Body or Response, look for the "Link Schema" dropdown. Selecting a global schema (e.g., 'User') creates a $ref in your spec.

Security & Servers

Authentication

Support for modern auth patterns.

  • API Key (Header/Query)
  • HTTP Bearer (JWT)
  • Basic Auth

Environments

Manage deployment targets.

  • Production URL
  • Staging / Dev
  • Localhost

Import & Export

Google Drive

Save and load workspaces directly from your Google Drive.

Local Files

Import/Export standard .yaml or .json files manually.