{"id":47278,"library":"codeceptjs-rest-demo","title":"CodeceptJS REST Demo","description":"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.","status":"active","version":"1.1.22","language":"javascript","source_language":"en","source_url":"https://github.com/kobenguyent/codeceptjs-rest-demo","tags":["javascript","codeceptjs","rest"],"install":[{"cmd":"npm install codeceptjs-rest-demo","lang":"bash","label":"npm"},{"cmd":"yarn add codeceptjs-rest-demo","lang":"bash","label":"yarn"},{"cmd":"pnpm add codeceptjs-rest-demo","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Core testing framework dependency for running tests with REST helper.","package":"codeceptjs","optional":false},{"reason":"Provides the REST helper for API testing.","package":"codeceptjs","optional":false},{"reason":"Used to generate Allure reports from test results.","package":"allure-commandline","optional":true}],"imports":[{"note":"CodeceptJS uses ESM internally but require is also supported.","wrong":"const REST = require('codeceptjs').REST","symbol":"REST","correct":"import { REST } from 'codeceptjs'"},{"note":"Default import is available, but require is common.","wrong":"const codeceptjs = require('codeceptjs')","symbol":"codeceptjs","correct":"import codeceptjs from 'codeceptjs'"}],"quickstart":{"code":"git clone https://github.com/kobenguyent/codeceptjs-rest-demo.git\ncd codeceptjs-rest-demo\nnpm install\nnpm test","lang":"javascript","description":"Clones the demo project, installs dependencies, and runs all REST API tests using CodeceptJS."},"warnings":[{"fix":"Upgrade Node.js to version 16 or higher.","message":"Requires Node.js v16+ and uses CodeceptJS 3.x. Older Node versions will fail.","severity":"gotcha","affected_versions":"<16"},{"fix":"Replace with a local mock server or another public API.","message":"Demo uses reqres.in which may have rate limits or availability issues.","severity":"gotcha","affected_versions":">=0"},{"fix":"Ensure codecept.conf.js includes REST in helpers with endpoint and timeout.","message":"REST helper in CodeceptJS requires setting 'REST' in codecept.conf.js. Missing configuration leads to 'REST helper is not enabled' errors.","severity":"gotcha","affected_versions":">=0"},{"fix":"Migrate to @allure-framework/allure-codeceptjs and update codecept.conf.js.","message":"Allure reports generation uses deprecated 'allure-commandline' package. Consider using '@allure-framework/allure-codeceptjs' for modern integration.","severity":"deprecated","affected_versions":">=0"}],"env_vars":null,"search_vec":"'1.1.22':42 '3.4.1':13 'allur':25 'api':9,22 'cadenc':46 'codeceptj':1,12,48 'dashboard':30 'demo':3,34 'demonstr':5 'grafana/prometheus':28 'helper':17 'javascript':47 'librari':38 'mock':21 'monitor':29 'project':6,35 'regular':44 'releas':45 'report':26 'reqres.in':19 'rest':2,8,16,49 'reus':40 'support':24 'test':10 'use':11,18 'version':41","created_at":"2026-06-07T16:50:42.081473+00:00","updated_at":"2026-06-07T16:50:42.081473+00:00","problems":[{"fix":"Run 'npm install codeceptjs --save-dev' in your project.","cause":"Missing local installation of codeceptjs in dependencies.","error":"Error: Cannot find module 'codeceptjs'"},{"fix":"Add REST to helpers in codecept.conf.js with endpoint and timeout.","cause":"REST helper not configured in codecept.conf.js.","error":"Error: helper REST is not enabled!"},{"fix":"Run 'npm install -g allure-commandline' or add as devDependency.","cause":"Allure command-line tool not installed or not in PATH.","error":"Error: Cannot find module 'allure-commandline'"}],"ecosystem":"npm","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":"https://github.com/kobenguyent/codeceptjs-rest-demo#readme","github":"https://github.com/kobenguyent/codeceptjs-rest-demo","docs":null,"changelog":null,"pypi":null,"npm":"codeceptjs-rest-demo","openapi_spec":null,"status_page":null,"smithery":null,"categories":["testing"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-06-07","next_check":"2026-09-05","install_tag":null}}