KOA REST

Koa.js REST API dengan Prisma, Zod, JWT, dan Dokumentasi Swagger

Proyek ini adalah skeleton REST API dasar yang dibangun dengan Koa.js, Prisma ORM, Zod untuk validasi, JWT untuk autentikasi, dan Swagger untuk dokumentasi API. Proyek ini dirancang sebagai titik awal untuk mengembangkan REST API yang skalabel dan aman.

Fitur

• Koa.js sebagai framework web
• Prisma ORM untuk interaksi dengan database
• Zod untuk validasi data
• JWT untuk autentikasi berbasis token
• Swagger UI untuk dokumentasi API otomatis
• Konfigurasi Lingkungan dengan file .env

Teknologi yang Digunakan

• Koa.js - Framework web ringan untuk Node.js
• Prisma - ORM modern untuk Node.js dan TypeScript
• Zod - Validasi skema berbasis TypeScript
• JWT - JSON Web Token untuk autentikasi
• Swagger - Pembuatan dokumentasi API

Instalasi

1. Clone Repositori

git clone https://github.com/cacing69/koa-rest.git
cd koa-rest

npm run install

# or

yarn install

2. Migrate & Seed Database

yarn migrate

Ketika ada perubahan baru pada file schema.prisma, jalankan perintah migrate untuk membuat file migrationnya, setelah migration selesai dibuat, untuk mengeksekusinya, bisa menggunakan command

yarn migrate:dev

Untuk mengisi database dengan seeder, gunakan command:

yarn seed

command ini akan menjalankan file seeder yang ada pada folder prisma/seeders/** yang sudah didaftarkan pada file prisma/seed.ts

3. Jalankan App

yarn dev

4. E2E Test

yarn test:e2e

5. Unit Test

yarn test:unit

6. Create Feature

./script/create-feature.sh feature-name

# Or

yarn feat:create feature-name

Nama feature harus menggunakan kebab-case

Buka http://localhost:3000 atau jika ingin mengakses swaggernya bisa di akses pada http://localhost:3000/docs

Hal-hal yang perlu diperhatikan

KOA-REST/
├── generated/          # Folder hasil generate dari `npx prisma generate`
├── node_modules/       # Dependencies
├── prisma/             # Prisma setup
│   ├── migrations/     # Migrations Prisma
│   ├── seeders/        # Seeder data
│   ├── migrate.ts      # Script migrasi
│   └── schema.prisma   # Schema database
├── src/                # Source code aplikasi
│   ├── configs/        # Konfigurasi app
│   ├── docs/           # Dokumentasi API (Swagger/OpenAPI)
│   ├── features/       # Fitur-fitur utama
│   │   ├── auth/       # Fitur otentikasi
│   │   ├── profile/    # Fitur profile
│   │   └── user/       # Fitur user
│   ├── shared/         # Komponen cross-cutting concern
│   ├── middlewares/    # Middleware global
│   ├── repositories/   # Repository pattern
│   ├── responses/      # Respon standar
│   ├── types/          # Tipe data kustom
│   ├── usecases/       # Use case pattern
│   └── validations/    # Validasi input
│   └── index.ts        # Poin entrypoint aplikasi
├── test/               # Test file
├── .env                # Variabel env
├── .env.example        # Contoh variabel env
├── jest.config.ts      # Konfigurasi testing
├── package.json        # Dependency & script
└── tsconfig.json       # Konfigurasi TypeScript