Esse documento tem como objetivo descrever o funcionamento da API para o chatbot de teste para a Stone.
Telegram nome do bot: stonedev_bot
Link geral da API: https://ezveld0pn1.execute-api.us-east-2.amazonaws.com/dev/
Link da coleção Postman: https://www.getpostman.com/collections/ddf08037c986693356c1
URL: https://ezveld0pn1.execute-api.us-east-2.amazonaws.com/dev/register
Essa função tem como funcionalidade gravar os dados de um funcionário, são eles: id, nome, idade, cargo
.
Observação: Como estamos usando o DynamoDB podemos utilizar a mesma função de registro para atualizar o funcionário.
Headers
headers = {
'Content-Type': 'application/json'
}
Body
{
"id":2,
"nome":"Adilmar Coelho Dantas",
"idade":28,
"cargo":"Analista de Ti"
}
Response
{
"statusCode": 200,
"message": "Salvo com sucesso"
}
Função - SEARCH
URL: https://ezveld0pn1.execute-api.us-east-2.amazonaws.com/dev/search
Essa função tem como funcionalidade de pesquisar um funcionário pelo seu nome
.
Body:
{
"nome":"Adilmar Coelho Dantas"
}
Response
{
"statusCode": 200,
"message": "Funcionario encontrado!",
"id": 2,
"nome": "Adilmar Dantas",
"idade": 28,
"cargo": "Analista de Ti"
}
Função - DELETE
URL: https://ezveld0pn1.execute-api.us-east-2.amazonaws.com/dev/delete
Essa função tem como funcionalidade deletar um funcionário pelo seu id
.
Body:
{
"id":2
}
Response
{
"statusCode": 200,
"message": "Deletado com sucesso"
}
Para realizar o deploy da API na AWS basta editar o arquivo Terraform com as suas credenciais:
access_key
, secret_key
Após isso execute o comendo: terraform plan
e em seguida terraform apply
.
Instalando no Windows
Sentando variáveis de ambiente no Windows
set PATH=%PATH%;C:\terraform
- Adilmar Dantas - akanehar@gmail.com