Documentation

API Craft is a files-first API IDE: your specs, requests, environments, workflows and docs are plain files in your git repo, edited through the desktop app, the craftr CLI, or any text editor. These docs cover all three.

New here? Two stops:

  1. Installation: desktop app and CLI, in a few minutes.
  2. Quick start: import the Petstore spec, run a request, see the files it produced.

Sections

  • Getting started: what API Craft is, installing it, and a first project end to end.
  • Concepts: the mental model: files-first, the API → resource → operation → instance hierarchy, OpenAPI as the source of truth, instance visibility, environments. Read once; everything else clicks.
  • Guides: task-oriented how-tos: importing and re-importing specs, request instances, auth and middlewares, workflows, documenting an API, CI/CD.
  • Interface: a tour of the desktop app, the command palette, and keyboard shortcuts.
  • Reference: the contract: every project file format, field by field.
  • CLI: every craftr command, grouped by namespace, with flags and examples.
  • Plugins: not available yet; describes what's reserved in the formats today and what's planned.

Something missing?

Bug, unclear page, or a question the docs don't answer: issues & discussions or [email protected].