RESTful API - Go Catalog

Proyek ini adalah sebuah RESTful API yang dibangun menggunakan Go dengan framework Echo. API ini berfungsi untuk mengelola katalog produk pakaian.

Struktur Proyek

Proyek ini menggunakan struktur direktori yang umum digunakan dalam pengembangan aplikasi Go untuk memisahkan berbagai lapisan aplikasi.

• cmd/: Direktori ini berisi titik masuk utama aplikasi.

  • main.go: File ini bertanggung jawab untuk menginisialisasi server web Echo, menyambungkan ke database, dan mendaftarkan rute API. Juga menangani command-line flags untuk migration dan seeding.

• • internal/: Direktori ini berisi semua logika inti aplikasi yang tidak untuk diekspor ke proyek lain.

  • database/: Mengelola semua yang berhubungan dengan database.

    • database.go: Berisi fungsi untuk terhubung ke database PostgreSQL menggunakan GORM.
    • migration.go: Berisi fungsi untuk migrasi database (AutoMigrate), drop tables, dan seeding data awal. Mengelola tabel product_clothes, orders, product_orders, dan users. Menyediakan fungsi DropTables(), Migrate(), Seed(), FreshSeed(), dan DropAndMigrate().

  • delivery/rest/: Menangani lapisan presentasi melalui REST API.

    • handler.go: Mendefinisikan struct handler utama dengan dependensi storeUsecase dan AuthUsecase untuk semua endpoint.
    • catalog_handler.go: Berisi implementasi handler untuk endpoint katalog (GET, POST, PATCH dengan partial update). Termasuk validasi menggunakan utils.ValidateStruct().
    • order_handler.go: Berisi implementasi handler untuk endpoint pemesanan produk (Order, GetOrderInfo, AdminGetAllOrder).
    • user/: Sub-direktori untuk handler autentikasi.
      • auh_handler.go: Berisi implementasi handler untuk autentikasi user (RegisterUser) dengan embedded struct dari rest.Handler.

  • delivery/routes/: Mengatur routing aplikasi.

    • router.go: Mengatur rute-rute API dan menghubungkannya dengan handler yang sesuai. Meliputi endpoint catalog, order, dan autentikasi (/auth/register).

  • middlewares/: Mengelola middleware aplikasi.

    • middlewares.go: Mendefinisikan middleware umum dan RoleChecker untuk authorization.
    • cors.go: Implementasi CORS middleware menggunakan Echo CORS dengan konfigurasi AllowOrigins: ["*"].

  • models/: Mendefinisikan struktur data (model) dan konstanta.

    • catalog.go: Mendefinisikan struct ProductClothes dengan GORM tags dan validasi untuk produk pakaian.
    • order.go: Mendefinisikan struct Order, ProductOrder, dan request models (OrderMenuRequest, GetOrderInfoRequest, GetAllOrderRequest) untuk sistem pemesanan dengan relasi database.
    • user.go: Mendefinisikan struct User untuk autentikasi dengan field Hash untuk menyimpan password yang di-encrypt, dan RegisterRequest untuk registrasi user.
    • constant/: Berisi nilai-nilai konstan yang digunakan di seluruh aplikasi.
      • catalog.go: Konstanta untuk tipe pakaian (shirt, pants, outerwear, accessories, shoes).
      • order.go: Konstanta untuk status order dan product order (pending, processing, completed, cancelled, failed).
      • user.go: Konstanta untuk roles user (admin, user, cashier, manager).

  • repository/: Direktori ini berisi logika akses data (Data Access Layer).

    • catalog/: Mengelola query database untuk katalog.
      • repository.go: Interface untuk repository katalog dengan CRUD operations.
      • catalog.go: Implementasi repository menggunakan GORM untuk operasi database catalog.
    • order/: Mengelola query database untuk pemesanan.
      • repository.go: Interface untuk repository order.
      • order.go: Implementasi repository menggunakan GORM untuk operasi database order dengan relasi ke ProductOrder menggunakan Preload().
    • users/: Mengelola query database untuk user management.
      • auth/: Repository khusus untuk autentikasi.
        • repository.go: Interface untuk repository autentikasi (RegisterUser, CheckRegistered, GenerateUserHash).
        • auth.go: Implementasi repository autentikasi dengan AES-GCM cipher dan konfigurasi Argon2.
        • hash.go: Implementasi password hashing menggunakan Argon2ID dengan enkripsi AES-GCM tambahan.

  • usecase/: Direktori ini berisi logika bisnis aplikasi.

    • store/: Mengelola logika bisnis untuk fitur toko/katalog dan pemesanan.
      • usecase.go: Interface untuk usecase toko dengan method untuk catalog dan order management.
      • store.go: Implementasi logika bisnis untuk catalog CRUD dan order processing dengan UUID generation, validasi, dan business rules.
    • auth/: Mengelola logika bisnis untuk autentikasi.
      • usecase.go: Interface untuk usecase autentikasi.
      • implements.go: Implementasi logika bisnis autentikasi dengan validasi user registration, password hashing, dan duplicate checking.
    • admin/: Reserved untuk logika bisnis admin (dalam pengembangan).
      • usecase.go: Placeholder untuk admin usecase.

  • utils/: Direktori untuk utility functions.

    • validator.go: Berisi fungsi validasi untuk struct validation dengan support untuk full validation (CREATE) dan partial validation (UPDATE). Menggunakan github.com/go-playground/validator/v10.
    • JWT.go: Placeholder untuk implementasi JWT token generation dan validation (dalam pengembangan).

🗄️ Struktur Database

Aplikasi menggunakan PostgreSQL dengan GORM sebagai ORM dan mengelola tabel-tabel berikut:

Tabel product_clothes

• Primary Key: id (auto-increment)
• Unique Key: unique_id (format: PRD-{uuid})
• Fields: nama_pakaian, price, deskripsi, stock, type_clothes

Tabel orders

• Primary Key: id (auto-increment)
• Unique Key: unique_id (format: ORD-{uuid})
• Unique Key: reference_id (untuk mencegah duplicate orders)
• Fields: status
• Relasi: Has Many product_orders

Tabel product_orders

• Primary Key: id (auto-increment)
• Foreign Key: order_unique_id → orders.unique_id
• Fields: product_id, nama_pakaian, quantity, total_price, status

Tabel users

• Primary Key: id (auto-increment)
• Unique Key: unique_id (format: USR-{uuid})
• Unique Fields: name, email, phone
• Fields: hash (encrypted password), address, roles

🔐 Security Features

Password Security

• Argon2ID hashing algorithm (winner of Password Hashing Competition)
• AES-GCM encryption untuk additional layer security
• Salt generation menggunakan crypto/rand
• No plaintext password storage - hanya hash yang disimpan

Database Security

• UUID untuk semua identifier (mencegah enumeration attacks)
• Unique constraints pada field sensitif
• Reference ID validation untuk mencegah duplicate orders
• GORM query protection terhadap SQL injection

API Security

• Struct validation menggunakan validator/v10
• Error handling yang tidak membocorkan informasi sensitif
• CORS configuration untuk cross-origin requests
• Type safety dengan Go's strong typing

Order Endpoints

• POST /order: Membuat pesanan baru.
  • Body: JSON dengan format:

  {
      "order_product": [
          {
              "product_id": "PRD-unique-id",
              "quantity": 2
          }
      ]
  }

Database Management

• Migration: Menggunakan GORM AutoMigrate untuk membuat/update schema
• Seeding: Data awal untuk testing dan development
• Fresh Migration: Drop semua tabel dan buat ulang dengan data baru

Validation

• Struct Validation: Menggunakan github.com/go-playground/validator/v10
• Partial Update Validation: Validasi khusus untuk update operations
• Business Logic Validation: Validasi di usecase layer

UUID Generation

• Unique Product ID: Setiap produk memiliki unique ID dengan format PRD-{uuid}
• Unique Order ID: Setiap order memiliki unique ID dengan format ORD-{uuid}

Error Handling

• Structured Error Response: Response error yang konsisten
• Logging: Error logging untuk debugging
• HTTP Status Codes: Status code yang sesuai untuk setiap scenario

Cara Menjalankan

1. Pastikan Anda memiliki Go dan PostgreSQL terinstal.
2. Ubah string koneksi database di cmd/main.go jika diperlukan.

   // filepath: cmd/main.go
   // ...existing code...
   const (
       dbAddress = "host=localhost port=5432 user=postgres password=postgres dbname=go_resto_app sslmode=disable"
   )
   // ...existing code...

3. Jalankan aplikasi dari direktori root.

   go run cmd/main.go

4. Server akan berjalan di port :8081.

Endpoint API

• GET /clothes: Mengambil semua data produk pakaian.
  • Query Param TypeClothes (opsional): Filter produk berdasarkan tipe (misal: shirt, pants).
  • Contoh: http://localhost:8081/clothes?TypeClothes=shirt

Tips dan Trik Go

Berikut adalah beberapa konsep dan konvensi penting dalam Go yang digunakan dalam proyek ini:

1. Visibilitas: Public (Exported) vs. Private (Unexported)

Go tidak menggunakan kata kunci seperti public atau private. Visibilitas (apakah sesuatu dapat diakses dari package lain) ditentukan oleh kapitalisasi nama:

• Huruf Kapital di Awal (PascalCase): Berarti Public atau Exported. Ini membuatnya bisa diakses dari package lain.

  • Contoh: rest.LoadRoutes(...), models.ProductClothes, repository.GetRepository(...).

• Huruf Kecil di Awal (camelCase): Berarti Private atau Unexported. Ini membuatnya hanya bisa diakses di dalam package yang sama.

  • Contoh: type menuRepo struct di dalam package repository. Struct ini tidak bisa diakses langsung dari package main.

Ini berlaku untuk nama struct, interface, function, method, dan variable di level package.

2. Error Handling

Pola umum di Go adalah mengembalikan error sebagai nilai terakhir dari sebuah fungsi. Pemanggilan fungsi tersebut harus selalu diikuti dengan pengecekan if err != nil.

data, err := someFunction()
if err != nil {
    // Handle error di sini
    return err
}
// Lanjutkan proses jika tidak ada error

3. Formatting Otomatis dengan go fmt

Go memiliki tool bawaan untuk memformat kode secara konsisten. Selalu jalankan perintah ini dari direktori root proyek Anda sebelum melakukan commit untuk menjaga kerapian kode:

go fmt ./...

4. Perintah-Perintah Berguna

Berikut adalah cara menggunakan berbagai perintah untuk mengelola aplikasi:

1. Jalankan server biasa

go run cmd/main.go

2. Migration saja (create/update tables)

go run cmd/main.go --migrate

3. Migration + seed

go run cmd/main.go --migrate --seed

4. Fresh migration (drop + create tables) - seperti migrate:fresh

go run cmd/main.go --fresh

5. Fresh migration + seed (drop + create + seed) - seperti migrate:fresh --seed

go run cmd/main.go --fresh --seed

6. Reset database (drop semua tables)

go run cmd/main.go --reset

7. Seed saja (jika tabel sudah ada)

go run cmd/main.go --seed