Skip to content
This repository was archived by the owner on Dec 10, 2021. It is now read-only.

docs: add API design overview #16

Open
wants to merge 14 commits into
base: master
Choose a base branch
from
Open

docs: add API design overview #16

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
d82182c
docs: add API design overview
sf-clouder Dec 4, 2019
d3f03d0
chore: project init
sf-clouder Jan 3, 2020
c0f870e
style: install prettier and eslint
sf-clouder Jan 3, 2020
a8e7a87
chore(cdk): install aws cdk core
sf-clouder Jan 3, 2020
74cff4f
chore(cdk): install cdk packages for apig, dynamo, lambda, sqs
sf-clouder Jan 3, 2020
d3ed2eb
feat(stack): basic cdk stack with dynamo table
sf-clouder Jan 3, 2020
fa3035a
feat(dynamo): add gsi for sk-state-city-zip
sf-clouder Jan 3, 2020
3e24cc3
feat(stack): add api gateway with resources for /users and /users/{id}
sf-clouder Jan 3, 2020
8fb7ee0
chore(lambda): install clone, clean, merge and logging packages
sf-clouder Jan 3, 2020
8051c09
feat(stack): add lambda layer to stack
sf-clouder Jan 3, 2020
72a48bf
feat(lambda): add create, read, update, delete functions
sf-clouder Jan 3, 2020
ef79d9b
feat(api): add user model to api for payload validation in front of c…
sf-clouder Jan 3, 2020
1d59d3b
docs: remove outdated api design overview
sf-clouder Jan 3, 2020
e3154f8
docs(readme): modify readme.md with info about architecture, deployme…
sf-clouder Jan 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions api-design-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# SuperFormula Back End design test

## Environment

- AWS Cloud Native
- API Gateway per-route entry points
- CRUD routes trigger Lambdas
- DynamoDB storage
- DLQ for catching errors
- Infrastructure as configuration/code

## Questions

1. Do we need to secure the API? (API key, lambda authorizer, something else?)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great question. Please secure the API with an authorizer lambda, if time allows.


2. Should the API generate the unique user ID? Or does the user request the User ID, and the API determines it's uniqueness?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would ask the same question back to you: what would you recommend and why?


3. Do we want to store the data exactly as shown in the model? (i.e. address as a simple string). Or do we want to break address into an object with attributes like street, city, state, zip, etc?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The model shown is only for the sake of simplicity.

However, we would welcome further improvements into an object model based on what you might deem appropriate. Address as an object definitely makes sense to me, in that regard.


```json
{
"id": "xxx", // user ID (must be unique)
"name": "backend test", // user name
"dob": "", // date of birth
"address": "", // user address
"description": "", // user description
"createdAt": "", // user created date
"updatedAt": "" // user updated date
}
```