https://github.com/rproenza86/taco-chef-service

Restful service to perform CRUD operations around the Tacos' Recipes.
https://github.com/rproenza86/taco-chef-service

api-integration aws-api-gateway aws-lambda aws-sam chai mocha restful-api stackery typescript

Last synced: 24 days ago
JSON representation

Restful service to perform CRUD operations around the Tacos' Recipes.

• Host: GitHub
• URL: https://github.com/rproenza86/taco-chef-service
• Owner: rproenza86
• Created: 2021-02-05T21:48:59.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-02-12T11:29:55.000Z (about 4 years ago)
• Last Synced: 2025-04-12T23:47:32.587Z (24 days ago)
• Topics: api-integration, aws-api-gateway, aws-lambda, aws-sam, chai, mocha, restful-api, stackery, typescript
• Language: TypeScript
• Homepage:
• Size: 11.5 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# taco-chef

> AWS Serverless Workshop

This is a serverless application to create a basic Restful service.

## Description

AWS serverless API project built using AWS SAM framework.

The stack is an orchestration of :

1. API Gateway

2. Lambda Functions

3. DynamoDB

4. Spoonacular.com API

## API Requirements

1. Consumers of the API should be able access full REST endpoints for the following actions:

    - Creating Taco recipes

    - Updating Taco recipes

    - Deleting Taco recipes

    - Retrieving a list of Taco recipes

    - Retrieve list of Taco sauces from Spoonacular.com Ingredient API

    - Post Taco Recipe to Spoonacular.com API and return Recipe Card image

2. Taco recipes consist of the following data:

    - Recipe Name

    - Recipe Description

    - Recipe Instructions

    - Ingredients:

        - Taco Shell

        - Taco Protein(s)

        - Taco Topping(s)

        - Taco Sauce(s)

3. The API should use some sort of mock DB and/or caching to persist the Taco recipe data

4. The API should contain at least one "positive" unit test and one "negative" unit test

## Solution Diagrams

### AWS Architecture Diagram

![solution](docs/images/solution.png)

### SAM Template Architecture Diagram

> **Interesting**: Using Stackery.com as service/platform to deploy, monitor and control the application stack.

![architecture](docs/images/architecture.png)

## How to Test

To perform the API operations you could use:

1. The `.rest` files placed on the [`docs/restFulCalls/`](https://github.com/rproenza86/taco-chef-service/tree/master/docs/restFulCalls) directory.

2. Postman collection shared on the  [`docs/postman/`](https://github.com/rproenza86/taco-chef-service/tree/master/docs/postman/) directory.

> For more details check the below demo

### Tests Demo

> **Important:** On new deployments, if the POST endpoint for the FormData's payload return "...db ops error", you maybe are missing an AWS API Gateway configuration: Go to your API -> Settings -> Binary Media Types and add the `multipart/form-data` binary time, re-deploy and test.

![demo](docs/images/demo.gif)