How kong/insomnia works
Insomnia is a desktop API client for designing, sending, testing, and mocking APIs, with local, Git, or cloud-backed collaboration. The principal workflow is to create or import a project, configure a request and environment, send it over a supported protocol, inspect the response, and optionally run tests. The repository also includes the Inso CLI for specification lint/export and collection runs. The map preserves documented product branches; several feature implementations are unsampled, so their internal connections are omitted or marked unverified.
Main entry points: cli.ts Inso CLI · collection.ts Request authoring · database-nedb.ts Local database · routes.ts Insomnia desktop
Components 23
API Client
- Insomnia desktop
packages/insomnia/src/routes.ts - Request authoring
packages/insomnia/src/common/collection.ts - Protocol debugging
packages/insomnia/src/common/network/send-action-runtime.ts - Response inspection
packages/insomnia-data/src/models/response.ts - Template rendering
packages/insomnia/src/common/templating/liquid-engine.ts - Script execution
packages/insomnia/src/scripting/quickjs-script-engine.ts
Design and Testing
- API design
packages/insomnia/src/common/api-specs.ts - Collection testing
packages/insomnia-testing/src/run/run.ts - API mocking
packages/insomnia-data/node-src/services/mock-server.ts
Data and Collaboration
- Resource models
packages/insomnia-data/src/models/db-models.ts - Local database
packages/insomnia-data/node-src/database/database-nedb.ts - Project service
packages/insomnia-data/node-src/services/project.ts - Git sync
packages/insomnia-vcs/src/vcs.ts - Cloud collaboration
packages/insomnia-api/src/project.ts - App local storage
packages/insomnia/src/main/electron-storage.ts
Inso CLI
- Inso CLI
packages/insomnia-inso/src/cli.ts - CLI data access
packages/insomnia-inso/src/db/index.ts - Specification lint
packages/insomnia-inso/src/commands/lint-specification.ts - Specification export
packages/insomnia-inso/src/commands/export-specification.ts - Run reporting
packages/insomnia-inso/src/commands/run-collection/result-report.ts
Extensions and Services
- Plugin extensions
packages/insomnia/src/common/plugins/types.ts - Insomnia account API
packages/insomnia-api/src/fetch.ts
Other components
- API developer
Connections 21
- API developer → Insomnia desktop: uses
README.md - Insomnia desktop → Request authoring: authors
- Request authoring → Protocol debugging: sends requests
- Protocol debugging → Response inspection: produces response
- Request authoring → Template rendering: renders values
- Request authoring → Script execution: runs scripts
- API developer → API design: designs APIs
README.md - API developer → Collection testing: tests collections
README.md - API developer → API mocking: mocks APIs
README.md - API developer → Inso CLI: runs CI
README.md - Inso CLI → CLI data access: loads data
packages/insomnia-inso/src/cli.ts - Inso CLI → Specification lint: invokes lint
packages/insomnia-inso/src/cli.ts - Inso CLI → Specification export: exports specs
packages/insomnia-inso/src/cli.ts - Inso CLI → Run reporting: updates report
packages/insomnia-inso/src/cli.ts - Local database → Project service: repairs projects
- Local database → Resource models: validates documents
packages/insomnia-data/node-src/database/database-nedb.ts - API developer → Git sync: chooses storage
README.md - API developer → Cloud collaboration: collaborates
README.md - API developer → App local storage: chooses storage
README.md - Plugin extensions → Template rendering: adds tags
packages/insomnia/src/common/templating/liquid-engine.ts - Insomnia account API → Cloud collaboration: supports collaboration