Getting Started

API Craft is an API IDE where everything is a file. The OpenAPI spec, the requests you run against it, your environments, and your documentation all live as plain files in your project's git repo. The desktop app and the craftr CLI are two interfaces over the exact same files: edit in one, see it in the other.

This makes an API project behave like the rest of your code: changes show up in git diff, get reviewed in pull requests, and run in CI. Nothing lives in a private cloud workspace.

What makes it different

• Files-first. Every request, environment, and override is a file on disk. Version it, review it, edit it with whatever tools you already use.
• Resources over routes. An API is a set of resources with operations (Pet.get, Pet.create), not a flat list of HTTP calls. The model maps cleanly onto files and onto the spec.
• OpenAPI is the source of truth. You import a spec once; the IDE keeps it as a living file and projects your edits on top, so the spec and your work never drift apart.
• One model, two interfaces. The GUI and the CLI share one core. Anything you do in the app can be scripted with craftr.

Where to go next

• Installation: install the app and the CLI.
• Quick start: import a spec and run your first request in a few minutes.
• Concepts: the mental model behind resources, instances, and environments.