no framework api

레시피 적용

레시피 API 서비스를 사용하는 간단한 애플리케이션입니다. 이는 데모 목적으로 제작되었으며 건축 및 프로그래밍 기술을 보여주기 위해 만들어졌습니다.

애플리케이션 아키텍처

다음은 주요 설계 포인트와 이를 처리 및 구현하는 방법입니다.

개요:

• 웹 서비스 컨테이너: 이 서비스는 API 게이트웨이 역할을 하며 모든 호출을 적절한 서비스로 라우팅합니다.
• Oauth-Service Container: 이 서비스는 액세스 토큰을 생성하고 생성하는 데 사용됩니다. 따라서 이를 사용하여 보호된 API/엔드포인트에 액세스할 수 있습니다.
• 검색 서비스 컨테이너: 이 서비스는 요청에서 쿼리를 가져와 Elasticsearch에서 레시피 결과를 가져와서 제공합니다.
• 레시피 서비스 컨테이너: 이 서비스는 모든 레시피 관련 API 엔드포인트를 제공합니다.
• Postgres-Recipe 컨테이너: 이 데이터베이스 컨테이너는 모든 레시피 관련 데이터를 저장하므로 레시피 서비스 컨테이너에서 액세스하고 사용합니다.
• Postgres-Oauth 컨테이너: 이 데이터베이스 컨테이너는 모든 oauth 관련 데이터를 저장하므로 oauth-service 컨테이너에서 액세스하고 사용합니다.
• Elasticsearch 컨테이너: 이 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

웹 서비스 컨테이너에서 승인 테스트를 실행합니다.

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

API 문서

Postman에서 공개 API 문서에 액세스할 수 있습니다. 모든 API를 가져오고 실행하려면 상단 표시줄에서 "Postman에서 실행"을 클릭하세요. 설치하고 가져온 후 새 컬렉션이 "HelloFresh-Recipes API"로 표시됩니다. 보호된 API에 액세스하려면 먼저 "인증 -> 토큰 가져오기" 엔드포인트에서 토큰 생성을 실행해야 합니다. 그런 다음 Postman 앱 내부 오른쪽 상단을 클릭하여 "HelloFresh-Dev" 환경 설정에서 "access_Token"을 업데이트합니다.