JXP

JXP is an opinionated RESTful API framework that lets you make an API just by defining models.

Features

• Takes care of the plumbing, like authentication and password encryption
• Get all the data you need with smart link population
• Search, sort, filter, populate... all on the url
• Get just the data you need with field selection
• Super-fast and easy to add and change models
• An obvious and standard API interface
• CSV output to quickly grab your data
• Permissioning and groups baked in
• Ability to handle business logic
• Simple to deploy
• Lightning-fast
• Logging, done
• Stateless

Quick Start

npm install -g jxp
jxp-setup my-app
cd my-app
npm start

Requires Node.js 22+.

Installing from source

npm i --legacy-peer-deps
npm run build   # compiles TypeScript (runs on git clone install when src/ is present)
npm start       # sample server at dist/bin/server.js

Requires Node.js 22+ and MongoDB for the sample server and integration tests.

TypeScript

JXP 4 is implemented in TypeScript. See docs/typescript.md for building from source, consuming types in JavaScript apps, and authoring typed models.

Documentation

• TypeScript / v4 migration
• Installation
• Configuration
• Authentication
• Schemas
• Restful API
• Roles and Permissions
• Hooks
• Special Features
• Changelog
• Full docs