Ir al contenido
yRest yRest

Programmatic API

Esta página aún no está disponible en tu idioma.

The programmatic API lets you start and stop a yRest server from inside your test suite or any Node.js script — no CLI, no separate process. Import createYrestServer, pass a config object, and use the running server URL in your tests.

import { createYrestServer } from "@yrest/cli";


const server = createYrestServer({ file: "./tests/db.yml", port: 3070 });
await server.start();
// run tests against http://localhost:3070
await server.stop();

Installation

Section titled “Installation”

createYrestServer(options)

Section titled “createYrestServer(options)”

Options reference

Section titled “Options reference”
OptionTypeDefaultDescription
filestring—Path to the YAML database file
portnumber3070Port to listen on
hoststring"localhost"Host to bind
basestring""URL prefix for all routes
readonlybooleanfalseReject all write operations
delaynumber0Simulated latency in ms
snapshotbooleanfalseEnable snapshot/reset endpoints

Return value — YrestServer

Section titled “Return value — YrestServer”

Lifecycle methods

Section titled “Lifecycle methods”

server.start()

Section titled “server.start()”

server.stop()

Section titled “server.stop()”

Typed collection access

Section titled “Typed collection access”

server.collection<T>(name) returns a typed CRUD handle for the named collection:

import type { User } from "./db.types"; // from yrest types codegen


const users = server.collection<User>("users");
users.findAll(); // User[]
users.findById(1); // User | undefined
users.create({ name: "Ana" }); // User
users.update(1, { name: "Ana M." });
users.delete(1);

Vitest example

Section titled “Vitest example”

Playwright example

Section titled “Playwright example”

Cypress example

Section titled “Cypress example”

Next steps

Section titled “Next steps”