no framework api

レシピの応用

レシピ API サービスを利用するためのシンプルなアプリケーション。これはデモを目的としており、アーキテクチャとプログラミングのスキルを実証するために作成されました。

アプリケーションアーキテクチャ

以下に主要な設計ポイントと、その処理と実装方法を示します。

概要：

• Web サービス コンテナ:このサービスは API ゲートウェイとして機能し、すべての呼び出しを適切なサービスにルーティングします。
• Oauth-Service Container:このサービスは、アクセス トークンの作成と生成に使用されます。したがって、それらを使用して、保護された API/エンドポイントにアクセスできます。
• Search-Service Container:このサービスはリクエストからクエリを取得し、Elasticsearch からレシピ結果をフェッチすることによってそれを提供します。
• Recipe-Service Container:このサービスは、すべてのレシピ関連の API エンドポイントを提供します。
• Postgres レシピ コンテナ:このデータベース コンテナにはすべてのレシピ関連データが保存されるため、レシピ サービス コンテナによってアクセスされ、消費されます。
• Postgres-Oauth コンテナ:このデータベース コンテナにはすべての oauth 関連データが保存されるため、oauth-service コンテナによってアクセスされ、消費されます。
• Elasticsearch コンテナ:この noSQL データベース コンテナには、すべてのレシピ関連データが保存されるため、検索サービス コンテナによってアクセスされ、消費されます。
• Redis コンテナ:このメモリ内のキーと値のコンテナには、すべてのレシピ関連イベントが保存されます。 Recipe-Service がイベントを生成し、Search-Service がイベントを消費します。

インストール

開発環境の要件:

• Git
• Docker >= 17.06 CE
• Docker Compose

セットアップ スクリプトを使用して、ローカル マシン上に開発環境をセットアップします。

$ 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 サービス コンテナで受け入れテストを実行します。

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

APIドキュメント

Postman でパブリック API ドキュメントにアクセスできます。すべての API をインポートして実行するには、上部バーの [Run In Postman] をクリックします。インストールしてインポートすると、新しいコレクションが「HelloFresh-Recipes API」として表示されます。保護された API にアクセスするには、最初に「認証 -> トークンの取得」エンドポイントからトークンの生成を実行する必要があります。次に、postman アプリ内の右上隅をクリックして、「HelloFresh-Dev」環境設定の「access_Token」を更新します。