Getting Started

Quick start

From sign-in to your first edited and tested endpoint in ten minutes.

Updated

OpenAPI Studio is a visual editor for OpenAPI 3.0 / 3.1 specs. You import or create a spec, edit endpoints in a node-graph view, run live requests against your API, and share or export the result. This page is a fast tour from zero to your first request.

1. Sign in

Go to openapistudio.app and sign in with GitHub or email + password. Your account is created on first login.

2. Create a workspace

A workspace is the unit of collaboration — its own member list, credentials store, and specs. From the dashboard, click New workspace and give it a name. One per project or team is the typical pattern.

3. Create or import a spec

Inside the workspace, click New spec. Pick one:

  • Blank — start with a minimal OpenAPI 3.0 skeleton.
  • Import URL — paste a swagger.json or openapi.yaml URL.
  • Import file — upload JSON or YAML.
  • Paste cURL — drop in a cURL command and we’ll turn it into an endpoint.
  • Swagger 2.0 — auto-converts to OpenAPI 3.0.

4. Explore the flow builder

Your spec’s paths are decomposed into a node graph: /api/users/{id} becomes /api → /users → /{id}. Click any endpoint node to open the editor.

See: Visual flow builder.

5. Edit an endpoint

The editor has three tabs:

  • Edit — form-based editing for parameters, request body, responses, security.
  • Run — execute the request through our server-side proxy (no CORS) and inspect the response.
  • History — every execution is captured for 7 days.

See: Editing endpoints.

6. Test it

On the Run tab, fill in parameters, attach auth, and click Execute. The response viewer shows status, headers, body, schema validation, and timing.

See: Running endpoints.

7. Share

  • Hotlinks — public URLs that serve your spec as JSON or YAML, edge-cached.
  • AsyncAPI export — for WebSocket endpoints, generate an AsyncAPI document.
  • Team invites — bring people in as Owner, Editor, or Viewer.

See: Sharing via hotlinks, Team collaboration.

What’s next

  • Concepts — workspaces, specs, roles, hotlinks at a glance.
  • Guides — step-by-step walkthroughs for each feature.
  • Integrations — connect Slack, GitHub, Linear, Notion, and AI assistants via MCP.