BBC Consumer Contracts

What BBC Consumer Contracts is

BBC Consumer Contracts is a free JavaScript project for describing executable API contracts from a consumer's perspective. Each contract specifies a consumer, a name, a request, and the expected response. The project uses the request package for HTTP calls and Joi to validate responses, including status codes, headers, and JSON bodies against Joi schemas. Optional before and after functions support setup and cleanup, with callback-based or asynchronous functions. Retry behavior can be numeric or custom; the documented default maximum is zero. From the command line, the consumer-contracts run command can validate files recursively in a contracts directory or run one chosen contract file. In code, validateContracts accepts an array and runs every contract in it rather than stopping at the first failure. The README documents global CLI installation and local development dependency installation with pnpm. The package metadata requires Node.js version 18 or later and pnpm version 10 or later. It is intended for API and self-hosted use. The repository identifies the license as Apache License 2.0 and directs requests for an alternative licence to the BBC. Request options may include SSL settings; the README also describes setting strictSSL to false when strict trust checking is not required.