no framework api

配方应用

一个使用菜谱 API 服务的简单应用程序。这是出于演示目的，旨在展示架构和编程技能。

应用架构

以下是关键设计点，以及如何处理和实施。

概述：

• Web 服务容器：该服务将充当 API 网关，并将所有调用路由到适当的服务。
• Oauth-Service Container：该服务将用于创建和生成访问令牌。因此，我们可以使用它们来访问受保护的 API/端点。
• Search-Service 容器：该服务将从请求中获取查询，并通过从 Elasticsearch 获取配方结果来提供服务。
• 配方服务容器：该服务将为所有与配方相关的 API 端点提供服务。
• Postgres-Recipe 容器：该数据库容器将存储所有与配方相关的数据，因此将由配方服务容器访问和使用。
• Postgres-Oauth 容器：该数据库容器将存储所有与 oauth 相关的数据，因此将由 oauth-service 容器访问和使用。
• Elasticsearch 容器：这个 noSQL 数据库容器将存储所有与配方相关的数据，因此将由搜索服务容器访问和使用。
• Redis 容器：这个内存中的键值容器将存储所有与配方相关的事件。 Recipe-Service 将生成事件，而 Search-Service 将使用事件。

安装

开发环境要求：

• git
• Docker >= 17.06 CE
• Docker 组合

使用安装脚本在本地计算机上设置开发环境：

$ 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，请单击顶部栏上的“在 Postman 中运行”，安装并导入后，您将看到新集合为“HelloFresh-Recipes API”。要访问受保护的 API，您需要首先从“身份验证 -> 获取令牌”端点运行生成令牌。然后通过单击邮递员应用程序内的右上角来更新“HelloFresh-Dev”环境设置中的“access_Token”。