API Coleta seletiva de lixo

API para cadastro de pontos de coleta de lixo seletivo

API foi desenvolvida ultilzando uma arquitetura bem definida e desacoplada, ultilizando TDD como metotologia de trabalho e Clean Architecture para fazer a distribição das resposabildades em camadas, e sempre que possível ultilizando os principios do SOLID.

API conciste em um mapeamento onde estão situados Pontos epecíficos de coleta de lixo seletivo, onde os usuários podem está cadastrando esses pontos atravez de coordenadas de latitude e longitude do local. Além das localizações, os items que os pontos podem recolher/coletar so podem ser cadastrados via Administrador do sistema.

A Aplicação está em constante desenvolvimento, cabendo sempre que possível novas funcionalidades.

Instruções para rodar o projeto

Os requisitos necessários são:

Node
npm
Mongodb

Faça o clone do projeto e rode o comando npm install para instalar as dependências.

npm install

Subir o servidor de desenvolvimento atravéz do comando npm run dev

npm run dev

Configurar as variáveis de ambiente criando um arquivo .env na raiz do projeto, e seguindo o examplo do arquivo .env.example.

Testes

Rodar todos os testes

npm test

Rodar testes de unidade

npm run test:unit

Rodar testes de integração

npm run test:integration

Rodar testes covarage

npm run test:ci

Documentação

A documentação foi desenvolvida utilizando o Swagger, e pode ser acessada através do endpoits /documentation

Principais funcionalidades

Cadastro
Login
Criar Itens
Listar Itens
Criar Localização
Listar Localização

Endpoints da aplicação

Rota de Cadastro

[POST] /api/v1/signup

Request body

{
   "name": "string",
   "email": "string",
   "password": "string",
   "passwordConfirmation": "string"
}

Responses

{
    "access_token": "string",
    "name": "string"
}

{
    "error": "string"
}

Rota de Login

[POST] /api/v1/login

Request body

{
  "email": "string",
  "password": "string"
}

Responses

{
    "access_token": "string",
    "name": "string"
}

{
    "error": "string"
}

Rota de Criar Item private

[POST] /api/v1/item

Parameters in header

{
    "x-access-token": "string"
}

Request body

{
    "title": "string",
    "image": "string"
}

Responses

success

error

{
    "error": "string"
}

Rota de Listar Itens private

[GET] /api/v1/item

Parameters in header

{
    "x-access-token": "string"
}

Responses

success

[
  {
	"id": "string",
	"title": "string",
	"image": "string"
  }
]

error

{
    "error": "string"
}

Rota para criar Localização private

[POST] /api/v1/location

Parameters in header

{
    "x-access-token": "string"
}

Request body

{
  	"name": "string",
	"email": "string",
	"latitude": number,
	"longitude": number,
	"city": "string",
	"uf": "string",
	"items": [
		{ "id": "string"},
		{ "id": "string"},
	]
}

Responses

success

{
  "surveyId": "string",
  "question": "string",
  "answers": [
    {
      "image": "string",
      "answer": "string",
      "count": number,
      "percent": number,
      "isCurrentAccountAnswer": boolean
    }
  ],
  "date": "string"
}

error

{
    "error": "string"
}

Rota para consultar uma localização por id

[GET] /api/v1/location/{locationId}

Parameters in route

{
"locationId": "string"
}

Responses

success

{
    "id": "string",
  	"location": {
		"name": "string",
		"email": "string",
		"latitude": number,
		"longitude": number,
		"city": "string",
		"uf": "string"
	},
	"items": [
		{
			"title": "string"
		},
		{
			"title": "string"
		}
	],
}

{
    "error": "string"
}

Rota para consultar uma localização por filtros, uf, city.

[GET] /api/v1/location

Responses

success

[
    {
        "id": "string",
      	"location": {
    		"name": "string",
    		"email": "string",
    		"latitude": number,
    		"longitude": number,
    		"city": "string",
    		"uf": "string"
    	},
    	"items": [
    		{
    			"title": "string"
    		},
    		{
    			"title": "string"
    		}
    	],
    }
]

[GET] /api/v1/location?city={city}&uf={uf}

Parameters in query string

{
"city": "string",
"uf": "string"
}

Responses

success

[
    {
        "id": "string",
      	"location": {
    		"name": "string",
    		"email": "string",
    		"latitude": number,
    		"longitude": number,
    		"city": "string",
    		"uf": "string"
    	},
    	"items": [
    		{
    			"title": "string"
    		},
    		{
    			"title": "string"
    		}
    	],
    }
]

{
    "error": "string"
}

juniorpaula / coleta-seletiva Goto Github PK

coleta-seletiva's Introduction

API Coleta seletiva de lixo

API para cadastro de pontos de coleta de lixo seletivo

Instruções para rodar o projeto

Testes

Rodar todos os testes

Rodar testes de unidade

Rodar testes de integração

Rodar testes covarage

Documentação

Principais funcionalidades

Endpoints da aplicação

Rota de Cadastro

Request body

Responses

Rota de Login

Request body

Responses

Rota de Criar Item private

Parameters in header

Request body

Responses

success

error

Rota de Listar Itens private

Parameters in header

Responses

success

error

Rota para criar Localização private

Parameters in header

Request body

Responses

success

error

Rota para consultar uma localização por id

Parameters in route

Responses

success

Rota para consultar uma localização por filtros, uf, city.

Responses

success

Parameters in query string

Responses

success

coleta-seletiva's People

Contributors

Stargazers

Watchers

Recommend Projects

Recommend Topics

Recommend Org