Giter VIP home page Giter VIP logo

serverless-challenge's Introduction

serverless-challenge

Como rodar a api

  • Dê um git clone do projeto para a máquina que deseja rodar
  • Rode o comando npm install
  • Em seguida o comando npm run up, este comando ficará responsável por rodar o docker do projeto e colocar a api pra rodar localmente(no docker)
  • Caso não seja definida uma porta para api no config env.ts a porta padrão será a 5050
  • Após alguns segundos, enquanto o docker instala as depêndencias e etc, é possível fazer os testes dos endpoints da api no postman

SE NÃO QUISER USAR O DOCKER

Caso não se queira usar o docker, tem como rodar a api local, só que para isso é necessário que tenha o MongoDB Atlas instalado na máquina Os passos mudam um pouco, tornando-se necessário rodar um comando a mais, sendo assim os comandos ficam:

  • npm install
  • npm run dev
  • Caso não seja definida uma porta para api no config env.ts a porta padrão será a 5050
  • Apos isso é possível fazer os testes dos endpoints da api no postman

Funcionalidades da API

Criar usuário

POST para http://localhost/API_PORT/api/user

Caso de sucesso

  • ✅ Recebe uma requisição do tipo POST na rota /api/user, que recebe os parâmetros (no body) : nome, idade e cargo
  • ✅ Cria um usuário com os dados fornecidos
  • ✅ Retorna 201, com os dados de cadastro + o id do registro inserido

Editar usuário

Caso de sucesso

PUT para http://localhost/API_PORT/api/user/:id

  • ✅ Recebe uma requisição do tipo PUT na rota /api/user/:id, com as informações para serem editadas no body
  • ✅ Edita o usuário ,cuja o id está nos params ,com os dados fornecidos no body
  • ✅ Retorna 201, com os dados de cadastro + o id do registro inserido

Listar usuários

Caso de sucesso

GET para http://localhost/API_PORT/api/user

  • ✅ Recebe uma requisição do tipo GET na rota /api/user
  • ✅ Retorna os usuários
  • ✅ Retorna 201, com a listagem dos usuários em forma de array

Remover usuário

Caso de sucesso

DELETE para http://localhost/API_PORT/api/user/:id

  • ✅ Recebe uma requisição do tipo DELETE na rota /api/user/:id
  • ✅ Remove o usuário pelo id passado nos params
  • ✅ Retorna 201, com os dados de cadastro + o id do registro inserido

serverless-challenge's People

Contributors

pedro-darde avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.