no framework api

Aplicação de receita

Um aplicativo simples para consumir serviços de API de receitas. Isto é para fins de demonstração e criado para demonstrar habilidades de arquitetura e programação.

Arquitetura de Aplicativo

Abaixo estão os principais pontos do design e como eles foram tratados e implementados.

Visão geral:

• Web-Service Container: Este serviço atuará como um gateway de API e encaminhará todas as chamadas para os serviços apropriados.
• Contêiner Oauth-Service: Este serviço será usado para criar e gerar tokens de acesso. Portanto, poderíamos usá-los para acessar APIs/endpoints protegidos.
• Search-Service Container: Este serviço pegará a consulta da solicitação e a atenderá buscando os resultados da receita do Elasticsearch.
• Contêiner de serviço de receita: este serviço atenderá todos os endpoints de API relacionados à receita.
• Postgres-Recipe Container: Este contêiner de banco de dados armazenará todos os dados relacionados à receita, portanto, serão acessados ​​​​e consumidos pelo contêiner de serviço de receita.
• Contêiner Postgres-Oauth: Este contêiner de banco de dados armazenará todos os dados relacionados ao oauth, portanto, serão acessados ​​​​e consumidos pelo contêiner oauth-service.
• Elasticsearch Container: Este contêiner de banco de dados noSQL armazenará todos os dados relacionados à receita e, portanto, será acessado e consumido pelo contêiner de serviço de pesquisa.
• Contêiner Redis: Este contêiner de valor-chave na memória armazenará todos os eventos relacionados à receita. O Recipe-Service produzirá os eventos e o Search-Service consumirá os eventos.

Instalação

Requisitos do ambiente de desenvolvimento:

• Git
• Docker >= 17.06 CE
• Composição do Docker

Configurando seu ambiente de desenvolvimento em sua máquina local usando o script de configuração:

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

Configuração 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 &

Agora você pode acessar o aplicativo via http://localhost:8000.

Executar testes

Execute os testes unitários no contêiner Recipe-Service:

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

Execute os testes de aceitação no contêiner do serviço Web:

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

Documentação da API

Você pode acessar a documentação pública da API em Postman. Para importar e executar todas as API's, clique em "Run In Postman" na barra superior, após instalar e importar você verá a nova coleção como "HelloFresh-Recipes API". Para acessar as APIs protegidas, você precisa primeiro executar a geração do token no endpoint "Autenticação -> Obter Token". Em seguida, atualize o "access_Token" na configuração do ambiente "HelloFresh-Dev" clicando no canto superior direito do aplicativo postman.