Can i use this in Production?

NOOO, A VERY BIG NO, this is a simple tool for teaching UI development

What is this?

A Simple REST API Server, without any logic or proper backend

Why was this created?

When i was looking to teach UI development, proper APIs are hard to come by, there are few read-only APIs that give public information but no read-write API (without any vendor lock-in like firebase)

How to Use this

download/build gradle build the Jar file and just run with JDK-17 or Later

java -jar rest-api.jar --port=8080 --db-name=app.db

What Endpoints are Available

The examples are given in test-api.http (intellij idea http request file)

• Create user POST /auth/create, x-www-form-urlencoded or form-data
• Authenticate POST /auth/validate, x-www-form-urlencoded or form-data
• get-all of a resource GET /api/{resource-name}
• create a resource POST /api/{resource-name}
• query a resource GET /api/{resource-name}?q={"key":"value"}
• get a resource GET /api/{resource-name}/{id}
• delete resource DELETE /api/{resource-name}/{id}
• update a resource PATCH /api/{resource-name}/{id} set value to null, to remove keys

What Database is Used

SQLite, all resources are saved in tables with just 2 columns; id, and data (of type JSON)

Tech

• Kotlin, one of my favourite languages
• Javalin, small and easy Web Framework
• Clikt, CLI parser for Kotlin
• SQLite
• Gradle, though I am a maven fellow, getting my hands dipped in gradle recently