no framework api

Rezeptanwendung

Eine einfache Anwendung zur Nutzung von Rezept-API-Diensten. Dies dient Demozwecken und wurde erstellt, um Architektur- und Programmierkenntnisse zu demonstrieren.

Anwendungsarchitektur

Nachfolgend finden Sie die wichtigsten Designpunkte und wie sie gehandhabt und implementiert wurden.

Überblick:

• Web-Service-Container: Dieser Dienst fungiert als API-Gateway und leitet alle Aufrufe an die entsprechenden Dienste weiter.
• Oauth-Service-Container: Dieser Dienst wird zum Erstellen und Generieren von Zugriffstokens verwendet. Wir könnten sie also verwenden, um auf die geschützten APIs/Endpunkte zuzugreifen.
• Suchdienst-Container: Dieser Dienst übernimmt die Abfrage aus der Anfrage und stellt sie bereit, indem er die Rezeptergebnisse von Elasticsearch abruft.
• Rezept-Service-Container: Dieser Dienst bedient alle rezeptbezogenen API-Endpunkte.
• Postgres-Recipe-Container: Dieser Datenbankcontainer speichert alle rezeptbezogenen Daten und wird daher vom Recipe-Service-Container abgerufen und genutzt.
• Postgres-Oauth-Container: Dieser Datenbankcontainer speichert alle OAuth-bezogenen Daten und wird daher vom OAuth-Service-Container abgerufen und genutzt.
• Elasticsearch-Container: Dieser NoSQL-Datenbankcontainer speichert alle rezeptbezogenen Daten und wird daher vom Suchdienstcontainer abgerufen und genutzt.
• Redis-Container: Dieser speicherinterne Schlüsselwertcontainer speichert alle rezeptbezogenen Ereignisse. Recipe-Service produziert die Ereignisse und Search-Service konsumiert die Ereignisse.

Installation

Anforderungen an die Entwicklungsumgebung:

• Git
• Docker >= 17.06 CE
• Docker Compose

Einrichten Ihrer Entwicklungsumgebung auf Ihrem lokalen Computer mithilfe des Setup-Skripts:

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

Manuelle Einrichtung:

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

Nun können Sie über http://localhost:8000 auf die Anwendung zugreifen.

Führen Sie Tests durch

Führen Sie die Unit-Tests im Recipe-Service-Container aus:

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

Führen Sie die Akzeptanztests im Web-Service-Container aus:

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

API-Dokumentation

Sie können auf die öffentliche API-Dokumentation bei Postman zugreifen. Um alle APIs zu importieren und auszuführen, klicken Sie in der oberen Leiste auf „In Postman ausführen“. Nach der Installation und dem Import wird die neue Sammlung als „HelloFresh-Recipes API“ angezeigt. Um auf die geschützten APIs zuzugreifen, müssen Sie zunächst die Generierung des Tokens vom Endpunkt „Authentifizierung -> Token abrufen“ ausführen. Aktualisieren Sie dann das „access_Token“ in der Umgebungseinstellung „HelloFresh-Dev“, indem Sie in der Postman-App auf die obere rechte Ecke klicken.