Desafio 01 - Construindo com serverless
Sobre o desafio
Nesse desafio foi criada uma parte da API de todos que foi desenvolvida no desafio Conceitos do Node.js mas dessa vez foi utilizado o framework Serverless.
Cada funcionalidade foi criada em um arquivo de função separado de acordo com o que foi visto no último módulo. Rotas necessárias para o Desafio:
POST - /todos/{userid}
GET- /todos/{userid}
Sobre as rotas
-
POST -
/todos/{userid}
Essa rota deve receber o
id
de um usuário pelopathParameters
(você pode criar esse id manualmente apenas para preencher o campo) e os seguintes campos no corpo da requisição:title
edeadline
, ondedeadline
é a data limite para o todo.O todo deverá ser salvo com os seguintes campos no DynamoDB:
{ id: 'uuid', // id gerado para garantir um único todo com o mesmo id user_id: 'uuid' // id do usuário recebido no pathParameters title: 'Nome da tarefa', done: false, // inicie sempre como false deadline: new Date(deadline) }
-
GET-
/todos/{userid}
Essa rota deve receber o
id
de um usuário pelopathParameters
(o mesmo id que foi usado para criar algum todo).A rota deve retornar os todos que possuírem o
user_id
igual aoid
recebido pelos parâmetros.
Milha Extra
Como complemento ao desafio foram criadas as seguintes rotas:
-
DELETE -
/todos/{todo_id}
Deleta um todo atráves do Id passado por path param. -
GET -
/todos
Lista todos os todos criados. -
PATCH -
/todos/{todo_id}/done
Altera a propriedadedone
do todo defalse
paratrue
.
Execução do Ambiente
-
Instalação do DynamoDB
yarn dynamodb:install
-
Iniciar o DynamoDB
yarn dynamodb:start
-
Iniciar o Serverless Offline
yarn dev
Serverless - AWS Node.js Typescript
This project has been generated using the aws-nodejs-typescript
template from the Serverless framework.
For detailed instructions, please refer to the documentation.
Installation/deployment instructions
Depending on your preferred package manager, follow the instructions below to deploy your project.
Requirements: NodeJS
lts/fermium (v.14.15.0)
. If you're using nvm, runnvm use
to ensure you're using the same Node version in local and in your lambda's runtime.
Using NPM
- Run
npm i
to install the project dependencies - Run
npx sls deploy
to deploy this stack to AWS
Using Yarn
- Run
yarn
to install the project dependencies - Run
yarn sls deploy
to deploy this stack to AWS
Test your service
This template contains a single lambda function triggered by an HTTP request made on the provisioned API Gateway REST API /hello
route with POST
method. The request body must be provided as application/json
. The body structure is tested by API Gateway against src/functions/hello/schema.ts
JSON-Schema definition: it must contain the name
property.
- requesting any other path than
/hello
with any other method thanPOST
will result in API Gateway returning a403
HTTP error code - sending a
POST
request to/hello
with a payload not containing a string property namedname
will result in API Gateway returning a400
HTTP error code - sending a
POST
request to/hello
with a payload containing a string property namedname
will result in API Gateway returning a200
HTTP status code with a message saluting the provided name and the detailed event processed by the lambda
⚠️ As is, this template, once deployed, opens a public endpoint within your AWS account resources. Anybody with the URL can actively execute the API Gateway endpoint and the corresponding lambda. You should protect this endpoint with the authentication method of your choice.
Locally
In order to test the hello function locally, run the following command:
npx sls invoke local -f hello --path src/functions/hello/mock.json
if you're using NPMyarn sls invoke local -f hello --path src/functions/hello/mock.json
if you're using Yarn
Check the sls invoke local command documentation for more information.
Remotely
Copy and replace your url
- found in Serverless deploy
command output - and name
parameter in the following curl
command in your terminal or in Postman to test your newly deployed application.
curl --location --request POST 'https://myApiEndpoint/dev/hello' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Frederic"
}'
Template features
Project structure
The project code base is mainly located within the src
folder. This folder is divided in:
functions
- containing code base and configuration for your lambda functionslibs
- containing shared code base between your lambdas
.
├── src
│ ├── functions # Lambda configuration and source code folder
│ │ ├── hello
│ │ │ ├── handler.ts # `Hello` lambda source code
│ │ │ ├── index.ts # `Hello` lambda Serverless configuration
│ │ │ ├── mock.json # `Hello` lambda input parameter, if any, for local invocation
│ │ │ └── schema.ts # `Hello` lambda input event JSON-Schema
│ │ │
│ │ └── index.ts # Import/export of all lambda configurations
│ │
│ └── libs # Lambda shared code
│ └── apiGateway.ts # API Gateway specific helpers
│ └── handlerResolver.ts # Sharable library for resolving lambda handlers
│ └── lambda.ts # Lambda middleware
│
├── package.json
├── serverless.ts # Serverless service file
├── tsconfig.json # Typescript compiler configuration
├── tsconfig.paths.json # Typescript paths
└── webpack.config.js # Webpack configuration
3rd party libraries
- json-schema-to-ts - uses JSON-Schema definitions used by API Gateway for HTTP request validation to statically generate TypeScript types in your lambda's handler code base
- middy - middleware engine for Node.Js lambda. This template uses http-json-body-parser to convert API Gateway
event.body
property, originally passed as a stringified JSON, to its corresponding parsed object - @serverless/typescript - provides up-to-date TypeScript definitions for your
serverless.ts
service file
Advanced usage
Any tsconfig.json can be used, but if you do, set the environment variable TS_NODE_CONFIG
for building the application, eg TS_NODE_CONFIG=./tsconfig.app.json npx serverless webpack