no framework api

การประยุกต์ใช้สูตร

แอปพลิเคชันง่าย ๆ สำหรับการใช้บริการ Recipe API มีจุดประสงค์เพื่อการสาธิตและสร้างขึ้นเพื่อสาธิตทักษะด้านสถาปัตยกรรมและการเขียนโปรแกรม

สถาปัตยกรรมแอปพลิเคชัน

ด้านล่างนี้คือประเด็นการออกแบบที่สำคัญ รวมถึงวิธีจัดการและนำไปใช้งาน

ภาพรวม:

• คอนเทนเนอร์บริการเว็บ: บริการนี้จะทำหน้าที่เป็นเกตเวย์ API และจะกำหนดเส้นทางการโทรทั้งหมดไปยังบริการที่เหมาะสม
• Oauth-Service Container: บริการนี้จะใช้เพื่อสร้างและสร้างโทเค็นการเข้าถึง ดังนั้นเราจึงสามารถใช้สิ่งเหล่านี้เพื่อเข้าถึง API/จุดสิ้นสุดที่ได้รับการป้องกันได้
• คอนเทนเนอร์บริการค้นหา: บริการนี้จะนำการสืบค้นจากคำขอและให้บริการโดยการดึงผลลัพธ์สูตรจาก Elasticsearch
• คอนเทนเนอร์บริการสูตร: บริการนี้จะให้บริการจุดสิ้นสุด API ที่เกี่ยวข้องกับสูตรทั้งหมด
• คอนเทนเนอร์ Postgres-Recipe: คอนเทนเนอร์ฐานข้อมูลนี้จะจัดเก็บข้อมูลที่เกี่ยวข้องกับสูตรอาหารทั้งหมด ดังนั้นจะถูกเข้าถึงและใช้งานโดยคอนเทนเนอร์บริการสูตรอาหาร
• คอนเทนเนอร์ Postgres-Oauth: คอนเทนเนอร์ฐานข้อมูลนี้จะจัดเก็บข้อมูลที่เกี่ยวข้องกับ oauth ทั้งหมด ดังนั้นจะถูกเข้าถึงและใช้งานโดยคอนเทนเนอร์บริการ oauth
• Elasticsearch Container: คอนเทนเนอร์ฐานข้อมูล noSQL นี้จะจัดเก็บข้อมูลที่เกี่ยวข้องกับสูตรทั้งหมด ดังนั้นคอนเทนเนอร์บริการค้นหาจึงจะเข้าถึงและใช้งานได้
• คอนเทนเนอร์ Redis: คอนเทนเนอร์คีย์-ค่าในหน่วยความจำนี้จะจัดเก็บเหตุการณ์ที่เกี่ยวข้องกับสูตรอาหารทั้งหมด Recipe-Service จะสร้างกิจกรรมและ Search-Service จะใช้กิจกรรม

การติดตั้ง

ข้อกำหนดด้านสภาพแวดล้อมการพัฒนา:

• คอมไพล์
• นักเทียบท่า >= 17.06 CE
• นักเทียบท่าเขียน

การตั้งค่าสภาพแวดล้อมการพัฒนาบนเครื่องของคุณโดยใช้สคริปต์การตั้งค่า:

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

การตั้งค่าด้วยตนเอง:

$ 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 &

ตอนนี้คุณสามารถเข้าถึงแอปพลิเคชันผ่านทาง http://localhost:8000

เรียกใช้การทดสอบ

รันการทดสอบหน่วยในคอนเทนเนอร์ Recipe-Service:

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

รันการทดสอบการยอมรับในคอนเทนเนอร์ Web-Service:

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

เอกสารประกอบ API

คุณสามารถเข้าถึงเอกสาร API สาธารณะได้ที่บุรุษไปรษณีย์ หากต้องการนำเข้าและเรียกใช้ API ทั้งหมด ให้คลิก "Run In Postman" ที่แถบด้านบน หลังจากติดตั้งและนำเข้าแล้ว คุณจะเห็นคอลเลกชันใหม่เป็น "HelloFresh-Recipes API" ในการเข้าถึง API ที่ได้รับการป้องกัน คุณจะต้องเรียกใช้การสร้างโทเค็นจากจุดสิ้นสุด "การรับรองความถูกต้อง -> รับโทเค็น" ก่อน จากนั้นอัปเดต "access_Token" ในการตั้งค่าสภาพแวดล้อม "HelloFresh-Dev" โดยคลิกที่มุมขวาบนภายในแอปบุรุษไปรษณีย์