Skip to content

ezzycreative1/svc-pokemon

Repository files navigation

svc-pokemon

REST API cake store sederhana yang dirancang dengan Arsitektur Heksagonal (Pola Port & Adaptor) dan aplikasi pengujian unit di setiap domain.

golang clean architecture

Fitur REST API

  • Create, Read, Update dan Delete Pokemon Battle Royale

Teknologi dan Framework

  • Golang
  • Echo Web Framework
  • MySQL
  • Docker Container

Menjalankan REST API

Untuk dapat menjalankan layanan ini terdapat 2 cara, pertama melalui lingkungan golang dan kedua melalui sistem container. Untuk struktur database sudah disiapkan secara langsung ketika service pertama kali dijalankan (sistem migrasi), tetapi terdapat data yang sifatnya referensi belum tersedia untuk fitur tsb. Untuk memenuhi data tsb kami sudah menyiapkan dummy data pada sumber cakes.sql dan cakes.sql, pastikan Anda berurutan melakukan eksekusi query data dummy.

  • Menjalankan pada lingkungan golang
    Sebelum menjalankan perintah dibawah ini, pastikan Anda sudah merubah nama file .env_example menjadi .env dan melakukan penyesuaian konfigurasi sesuai dengan lingkungan yang ada disana. Cukup jalankan kode di bawah ini di konsol Anda:

    go run .

    Anda dapat melihat di http://localhost:8000 secara default.

  • Menjalankan pada lingkungan container
    Menjalankan service melalui sistem container, dimana service akan dibungkus dalam sebuah sistem container. Semua kebutuhan yang berkaitan dengan bahasa golang, pustaka dan perkakas lainnya akan disiapkan dan dibungkus menjadi sebuah image container yang siap digunakan. Sebelum ke sana pastikan Anda sudah menginstall docker dan docker compose.

    Cukup jalankan kode di bawah ini di konsole Anda:

    docker-compose up -d --build

    Anda dapat melihat di http://localhost:8000 secara default.

    Docker akan melakukan pembuatan image container dan akan membuat instan container yang siap digunakan dibelakang layar. Anda tidak perlu repot memikirkan kebutuhan untuk menjalankan service, database dll, docker sudah menyiapkan semua kebutuhan itu dan Anda tinggal menunggunakannya saja. Sebagai catatan proses tersebut membutuhkan jaringan internet untuk mendownload kebutuhan dalam container dan image yang tidak terdapat pada lokal drive Anda.

    Menon-aktifkan container

    docker-compose stop

    Men-aktifkan container

    docker-compose start

    Menghapus container

    docker-compose down

Menggunakan REST API

Kami menyiapkan dokumentasi penggunaan REST API dalam bentuk koleksi Postman yang sudah siap digunakan , sebelum itu pastikan Anda sudah meng-install Postman. Untuk file koleksi postman dapat di lihat di postman_collection.json.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages