Botkeep
← All starters

Express API

A small JSON API with health checks, input validation and graceful shutdown.

Open in configurator

Files generated locally. No credentials needed to download.

Before you start

Node.js 22.9+ within 22.x and npm.

Dependencies

  • Express 5.2.1

Run locally

  1. 1

    Run npm install, then npm run check. Keep package-lock.json and use npm ci for repeatable installs.

  2. 2

    Optionally copy .env.example to .env. Run npm start; by default it only listens on your computer.

  3. 3

    Open http://127.0.0.1:3000/health and /api/greeting?name=Botkeep. A name longer than 60 characters returns 400.

Environment checklist

HOSTOptional
Defaults to 127.0.0.1 locally. Use the interface required by your actual host.
PORTOptional
Local default: 3000. Use the allocated port when hosted.

What is not included

No authentication or database is included. Add authorization, rate limits and persistent storage before exposing private data. HTTP routing and TLS are not active in the Botkeep preview.

The configurator prepares files and settings. Confirm deployment, add your credentials in Environment and check Console to verify startup.

Official documentation

README.md

# Express API

A small JSON API with health checks, input validation and graceful shutdown.

## Requirements
Node.js 22.9+ within 22.x and npm.

## Setup
1. Run npm install, then npm run check. Keep package-lock.json and use npm ci for repeatable installs.
2. Optionally copy .env.example to .env. Run npm start; by default it only listens on your computer.
3. Open http://127.0.0.1:3000/health and /api/greeting?name=Botkeep. A name longer than 60 characters returns 400.

## Variables
- HOST: Defaults to 127.0.0.1 locally. Use the interface required by your actual host.
- PORT: Local default: 3000. Use the allocated port when hosted.

## Boundaries
No authentication or database is included. Add authorization, rate limits and persistent storage before exposing private data. HTTP routing and TLS are not active in the Botkeep preview.

Downloading does not deploy anything. The Botkeep preview stores files in your browser but does not execute processes, install packages or activate networking. Do not enter real credentials in the demo. Direct dependencies are versioned: keep generated lockfiles and review updates and vulnerabilities before production.

## Sources
- Express: https://expressjs.com/en/starter/hello-world/