no framework api

Aplikasi Resep

Aplikasi sederhana untuk menggunakan layanan api resep. Ini untuk tujuan demo dan dibuat untuk menunjukkan keterampilan arsitektur & pemrograman.

Arsitektur Aplikasi

Di bawah ini adalah poin-poin desain utama, dan cara penanganan & penerapannya.

Ringkasan:

• Kontainer Layanan Web: Layanan ini akan bertindak sebagai gateway API dan akan merutekan semua panggilan ke layanan yang sesuai.
• Oauth-Service Container: Layanan ini akan digunakan untuk membuat dan menghasilkan token akses. Jadi, kita bisa menggunakannya untuk mengakses API/titik akhir yang dilindungi.
• Kontainer Layanan Pencarian: Layanan ini akan mengambil kueri dari permintaan dan menyajikannya dengan mengambil hasil resep dari Elasticsearch.
• Wadah Layanan Resep: Layanan ini akan melayani semua titik akhir API terkait resep.
• Kontainer Resep Postgres: Kontainer database ini akan menyimpan semua data terkait resep, sehingga akan diakses dan digunakan oleh kontainer layanan resep.
• Kontainer Postgres-Oauth: Kontainer database ini akan menyimpan semua data terkait oauth, sehingga akan diakses dan digunakan oleh kontainer layanan oauth.
• Kontainer Elasticsearch: Kontainer database noSQL ini akan menyimpan semua data terkait resep, sehingga akan diakses dan digunakan oleh kontainer layanan pencarian.
• Redis Container: Wadah nilai kunci dalam memori ini akan menyimpan semua peristiwa terkait resep. Recipe-Service akan menghasilkan acara dan Search-Service akan menggunakan acara tersebut.

Instalasi

Persyaratan lingkungan pengembangan:

• Git
• Buruh pelabuhan >= 17,06 M
• Penulisan Docker

Menyiapkan lingkungan pengembangan Anda di mesin lokal Anda menggunakan skrip pengaturan:

$ git clone https://github.com/ahsanatiq/no-framework-api
$ cd ahsanatiq-api-test
$ git checkout dev
$ ./setup.sh

Pengaturan manual:

$ git clone https://github.com/ahsanatiq/no-framework-api
$ cd ahsanatiq-api-test
$ git checkout dev
$ cp recipe-service/.env.dev recipe-service/.env
$ cp oauth-service/.env.dev oauth-service/.env
$ cp search-service/.env.dev search-service/.env
$ cp web-service/.env.dev web-service/.env
$ docker-compose up -d
$ docker exec -it ahsanatiq-recipe-service composer install
$ docker exec -it ahsanatiq-oauth-service composer install
$ docker exec -it ahsanatiq-search-service composer install
$ docker exec -it ahsanatiq-web-service composer install
$ docker exec -it ahsanatiq-recipe-postgres createdb -U hellofresh -O hellofresh hellofresh_testing
$ docker exec -it ahsanatiq-postgres-oauth createdb -U hellofresh -O hellofresh hellofresh_testing
$ docker exec -it ahsanatiq-oauth-service openssl genrsa -out /server/keys/id_rsa 2048
$ docker exec -it ahsanatiq-oauth-service openssl rsa -in /server/keys/id_rsa -pubout -out /server/keys/id_rsa.pub
$ docker exec -it ahsanatiq-recipe-service php vendor/bin/phinx migrate
$ docker exec -it ahsanatiq-oauth-service php vendor/bin/phinx migrate
$ docker exec -it ahsanatiq-oauth-service php vendor/bin/phinx seed:run
$ docker exec -it ahsanatiq-oauth-service php vendor/bin/phinx migrate -e testing
$ docker exec -it ahsanatiq-oauth-service php vendor/bin/phinx seed:run -e testing
$ docker exec ahsanatiq-search-service nohup /usr/bin/php /server/http/console.php consume:recipes &

Sekarang Anda dapat mengakses aplikasi melalui http://localhost:8000.

Jalankan Tes

Jalankan pengujian unit dalam wadah Resep-Layanan:

$ docker exec -it ahsanatiq-recipe-service php vendor/bin/codecept run

Jalankan tes penerimaan di kontainer Layanan Web:

$ docker exec -it ahsanatiq-web-service php vendor/bin/codecept run

dokumentasi API

Anda dapat mengakses dokumentasi API publik di Tukang Pos. Untuk mengimpor dan menjalankan semua API, klik "Jalankan Di Tukang Pos" di bilah atas, setelah menginstal dan mengimpor Anda akan melihat koleksi baru sebagai "API HelloFresh-Recipes". Untuk mengakses API yang dilindungi, Anda perlu menjalankan pembuatan token terlebih dahulu dari titik akhir "Otentikasi -> Dapatkan Token". Kemudian perbarui "access_Token" di pengaturan lingkungan "HelloFresh-Dev" dengan mengklik pojok kanan atas di dalam aplikasi tukang pos.