From the panel or the terminal
The Test Cases page runs a test case and shows every test as the server reports it. npm run test runs them all, or the ones you name, from the folder of the local client: for you, or for your AI assistant.
Team & delivery
Testing Framework
Test the business logic of your custom APIs and utility classes, inside API Maker.
A test case is a file of small tests, in TypeScript or in any other language API Maker runs, with the assertions of that language. Mocks stand in for the database and system APIs, so a test checks your logic without touching real data. Run them from the panel or from your terminal, and see each result with the line that failed and the lines that ran.
See it live
Step through it, slow it down, or open the full canvas.
api-maker/features/inbuilt-testingLive- Tests
- 2in the case
- Passed
- 0last run
- Database calls
- 0mocked
- Runs in
- 1the sandbox
Test cases live next to your code. A test case is a file of small tests, in any of the 8 languages. In TypeScript, as here: an array of tests, each with a name and an async function using node:assert. Import your utility classes and call them with g.
How it works
Test cases live next to your code.
A test case is a file of small tests, in any of the 8 languages. In TypeScript, as here: an array of tests, each with a name and an async function using node:assert. Import your utility classes and call them with g.
Mocks stand in for the database.
Pick an API method, here g.sys.db.query, the values its arguments must have and what it returns. A matching call gets that value, no database needed.
They run in the sandbox.
Each test calls your real code. The query is answered by the mock, the database is not called, and every assert is checked.
Run them all, or the ones you pick.
Execute runs every test of the test case you are on. Run lets you check the test cases you want. Each small test shows its own result.
A change that breaks a rule is caught.
Someone moves the discount threshold. The failing test shows the assert message and its line in your code, before anything is deployed.
What you get
Reviewed like code
Test cases go to Git with the rest of the project, so a pull request shows the tests next to the change.
Code coverage
Every run reports which lines of your custom APIs, utility classes and test cases ran, on the page and as an lcov file for VS Code and WebStorm.
An example
Catch a broken rule before release
Someone changes the discount threshold in a utility class. The test case fails with its message and line, before the change reaches a pull request.
import * as T from 'types';import * as assert from 'node:assert';import * as pricing from 'utils/Pricing';module.exports = [ { name: 'No discount under 1000', code: async (g: T.IAMGlobal) => { assert.strictEqual(await pricing.discountFor(g, 999), 0); }, }, { name: '10% from 1000', code: async (g: T.IAMGlobal) => { assert.strictEqual(await pricing.discountFor(g, 1000), 100); }, },];Watch it
On the real admin panel, with real data.
Length 7:04Test cases in depthMocks That Fail, Count and Compute : Test Cases in 8 Languages and in CI
Length 6:13CoverageCode Coverage of Backend Tests in Eight Languages
Length 5:44API TestingAPI Testing in the Panel: Call, Debug, Export and Share Any API
Length 8:43DebuggingDebug an API from the Failing Call to the Line That Broke
Good to know
- Calls that no mock matches reach the real API, so keep test data in mind when a test is not fully mocked.
- Code coverage is not collected on Bun, and for Java and Kotlin it needs JDK 24 or later.
Questions
Where do tests run?
On the server, in the sandbox of your account for the language of the test case, like your custom APIs. A test can run a custom API written in another language.
Can I test an API end to end?
Yes, from the API testing page: send a request with any body and headers, read the response, and keep it as a saved state.