⌘K

GitLabnpm
Documentation
/
Getting Started

Getting Started

v0.00
TypeScript

Create a full API in 2 minutes

1. Create Your First Project

1npx wappi init

Follow the prompts

2. Start Development Server

1npx wappi run

Will output something like this:

1
2⨁ WAPPI 2.0.13
3
4 ✓  Compiled 27 endpoints in 263ms 
5 ✓  Ready in 2.3s
6 ✓  Watching all changes in the API folder
7
8... -.- .. .--.
9 ✓  Compiled and Ready
10... -.- .. .--.
11  Environment : localhost
12  Show Logs   : true
13  Auth Cron   : 1  day
14  Auth Start  : Fri Jun 27 2025 11:53:40 GMT+1000 (Australian Eastern Standard Time)
15
16  WAPPI       :  http://localhost:3030
17.-- .- .--. .--. ..
18
19 ↻  Compiling changes
20 ✓  Compiled changes in 461ms
21 ✓  Types compiled and synced to: ["/Users/Sites/my_app/src/API"]
22

Your API will be available at the port you specified in the setup http://localhost:3030

3. Create Your First Endpoint

1npx wappi create

This creates a new endpoint template.

4. Test Your Endpoint

1npx wappi test Core_Login_1_0_0

This will run a test on the code in the Core Login endpoint.
Change the name of the endpoint to test another endpoint.