/omnistack10-backend

Projeto Backend produzido durante a Semana OmniStack 10.0

Primary LanguageJavaScript

Near Dev

Este é um projeto desenvolvido durante a semana OmniStack 10 da RocketSeat.

Com ele, é possivel cadastrar e verificar usuarios próximos de sua localização exeibindo as stacks de cada um, informações do Github e sua localização.

O QUE TEM NO BACKEND

SCRIPTS

  • start: Rodar projeto localmente com o node.
  • dev. Rodar o projeto localmente com o Nodemon.

VARIAVEIS DE AMBIENTE

Na pasta backend crie um arquivo .env com a seguinte informação:

MONGO_URL 
  • MONGO_URL: Sua URL de conexão do mognodb

Códigos de Status HTTP

  • 200: OK; Resposta padrão para solicitações HTTP bem-sucedidas (Listamos alguma coisa e recebemos)
  • 201: Criado; A solicitação foi atendida. Novo recurso criado ou editado (POST, PUT e PATCH)
  • 204: sem conteúdo; Solicitação processada. Nenhum conteúdo retornado (Não esperamos nenhum conteudo, DELETE)
  • 301: mudou-se permanentemente; Este e todos os pedidos futuros direcionados para o URI fornecido
  • 304: Não Modificado; O recurso não foi modificado desde a última solicitação
  • 400: Solicitação Inválida; Pedido não pode ser preenchido devido a sintaxe incorreta
  • 401: não autorizado; A autenticação é possível, mas falhou
  • 403: Proibido; Servidor se recusa a responder ao pedido
  • 404: não encontrado; Recurso solicitado não foi encontrado (Pesquisando por um ID X e não foi encontrado)
  • 500: Erro interno do servidor; Mensagem de erro genérica quando o servidor falha
  • 501: Não implementado; O servidor não reconhece o método ou não tem capacidade para cumprir
  • 503: serviço indisponível; O servidor está indisponível no momento

EXEMPLOS DE ENDPOINTS

Metodos EndPoint Descrição
GET /devs Retorna a lista de devs
POST /devs Cria um novo dev
PUT /devs/:id Atualiza o Dev mediante o ID informado
DELETE /devs/:id Apaga o Dev mediante o ID informado

TESTADORES DE API

Existe internamente um arquivo com as rotas iniciais para ser importado no Postman, Insominia e Afins. É recomendado apagar este arquivo ou mover para outro lugar para não ficar disponivel em produção possibilitando uma possivel falha de segurança na descoberta de informações sensiveis.

Para importar no Insominia:

Run in Insomnia}

O arquivo esta localizado em src > public > api > v1 > insominia.json para importar no D+ manualmente.