Registry / testing / codeceptjs-rest-demo

codeceptjs-rest-demo

library1.1.22jsnpmunverified

A demonstration project for REST API testing using CodeceptJS 3.4.1 with the REST helper. Uses reqres.in as mock API and supports Allure reporting and Grafana/Prometheus monitoring dashboard. This is a demo project, not a library for reuse. Version 1.1.22, no regular release cadence.

testing

npm install codeceptjs-rest-demo

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · CODECEPTJS-REST-DE

codeceptjs-rest-demo

testingjavascriptv1.1.22

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.

REST

✓ import { REST } from 'codeceptjs'

✗ const REST = require('codeceptjs').REST

CodeceptJS uses ESM internally but require is also supported.

codeceptjs

✓ import codeceptjs from 'codeceptjs'

✗ const codeceptjs = require('codeceptjs')

Default import is available, but require is common.

Clones the demo project, installs dependencies, and runs all REST API tests using CodeceptJS.

git clone https://github.com/kobenguyent/codeceptjs-rest-demo.git cd codeceptjs-rest-demo npm install npm test

Debug

Known issues

gotchaRequires Node.js v16+ and uses CodeceptJS 3.x. Older Node versions will fail.

fix

Upgrade Node.js to version 16 or higher.

affects: <16

gotchaDemo uses reqres.in which may have rate limits or availability issues.

fix

Replace with a local mock server or another public API.

affects: >=0

gotchaREST helper in CodeceptJS requires setting 'REST' in codecept.conf.js. Missing configuration leads to 'REST helper is not enabled' errors.

fix

Ensure codecept.conf.js includes REST in helpers with endpoint and timeout.

affects: >=0

deprecatedAllure reports generation uses deprecated 'allure-commandline' package. Consider using '@allure-framework/allure-codeceptjs' for modern integration.

fix

Migrate to @allure-framework/allure-codeceptjs and update codecept.conf.js.

affects: >=0

Errors

Common errors & fixes

Error: Cannot find module 'codeceptjs'

Missing local installation of codeceptjs in dependencies.

fix

Run 'npm install codeceptjs --save-dev' in your project.

Error: helper REST is not enabled!

REST helper not configured in codecept.conf.js.

fix

Add REST to helpers in codecept.conf.js with endpoint and timeout.

Error: Cannot find module 'allure-commandline'

Allure command-line tool not installed or not in PATH.

fix

Run 'npm install -g allure-commandline' or add as devDependency.

Upgrade

Version history

1.1.22latest on npm

Audit

Dependencies

codeceptjsrequiredCore testing framework dependency for running tests with REST helper.

codeceptjsrequiredProvides the REST helper for API testing.

allure-commandlineoptionalUsed to generate Allure reports from test results.

Agent activity

15 hits · last 30 days

node

Amazon

OpenAI (training)

Resources

githubhttps://github.com/kobenguyent/codeceptjs-rest-demo ↗

packagecodeceptjs-rest-demo ↗

homepagehttps://github.com/kobenguyent/codeceptjs-rest-demo#readme ↗