just-api

library1.2.5jsnpmunverified

Just-API is a declarative, specification-based API test framework for REST and GraphQL APIs. Users define tests in YAML files without writing code, but can extend with custom JavaScript functions. The current stable version is 1.2.5. It supports parallel/serial execution, hooks, chained requests, retries, and multiple report formats (HTML, JSON). Unlike code-heavy frameworks like Mocha or Supertest, Just-API emphasizes a spec-driven approach for rapid test creation and maintenance.

testing

npm install just-api

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · JUST-API

just-api

testingjavascriptv1.2.5

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

just-api

✓ npx just-api

✗ npm run just-api (if not in scripts)

CLI tool, invoked via npx or node_modules/.bin

Require

✓ const justAPI = require('just-api')

✗ import justAPI from 'just-api'

Package is CommonJS, not ESM

Suite

✓ const { Suite } = require('just-api')

✗ import { Suite } from 'just-api'

Named exports available for programmatic usage

Create a YAML test suite file and run it with just-api CLI.

mkdir specs cat << 'EOF' > specs/test.yml meta: name: Example suite configuration: scheme: https host: jsonplaceholder.typicode.com specs: - name: get posts request: path: /posts/1 method: get response: status_code: 200 EOF npx just-api specs/test.yml

Debug

Known issues

gotchaRequest library deprecated: request has been deprecated, consider using node-fetch or axios for custom validators

fix

Use custom JavaScript function with your own HTTP client

affects: all

deprecatedNode.js <10 is no longer supported in newer versions

fix

Upgrade Node.js to v10+

affects: >=1.0.0

gotchaYAML anchoring/aliasing may cause unexpected test behavior

fix

Avoid YAML anchors in spec files

affects: all

Errors

Common errors & fixes

Error: Cannot find module 'just-api'

Package not installed locally

fix

Run `npm install --save-dev just-api` and ensure node_modules is present

just-api: command not found

Binary not in PATH

fix

Use `npx just-api` or `./node_modules/.bin/just-api`

Upgrade

Version history

1.2.5latest on npm

Audit

Dependencies

mocharequiredTest runner/assertion framework used internally

chairequiredAssertion library used for response validation

requestrequiredHTTP client for making API requests

Agent activity

6 hits · last 30 days

node

Resources

githubhttps://github.com/kiranz/just-api ↗

packagejust-api ↗

homepagehttps://kiranz.github.io/just-api/ ↗