API gestor do povo

Api gestor do povo feita em Nest.js.

Autores

@car1nhanha

🚀 Documentação da API

🗒 Lista de rotas suportadas e seus respectivos parametros.

Verbos suportados

🔵 GET
🟢 POST
🟡 PUT
🔴 DELETE

Tag Usuário

Retorna todos os usuários

  GET /api/users 🔵

Parâmetro	Tipo	Descrição
_	_	_

Retorna um único usuário com base no id

  GET /api/users/{id} 🔵

Parâmetro	Tipo	Descrição
_	_	_

Criação de um novo usuário

  POST /api/users 🟢

Parâmetro	Tipo	Descrição
`name`	`string`	Obrigatório. Nome do usuário
`email`	`string`	Obrigatório. Email do usuário
`function`:	`string`	Obrigatório. Função do usuário, a maioria daz vezes será voluntário
`avatar`	`string`	Foto do usuário, não é obrigatório
`password`	`string`	Obrigatório. Senha do usuário, sempre acima de 8 caracteres
`level`:	`number`	Aínda tem que ser definido
`pasta`:	`[string]`	Array de pastas
`cep`:	`string`	Obrigatório. Cep sem o traço

Atualização de um usuário previamente cadastrado

não pode ser passado um email

  POST /api/users/{id} 🟡

Parâmetro	Tipo	Descrição
`name`	`string`	Nome do usuário
`function`:	`string`	Função do usuário, a maioria daz vezes será voluntário
`avatar`	`string`	Foto do usuário, não é obrigatório
`password`	`string`	Senha do usuário, sempre acima de 8 caracteres
`level`:	`number`	Aínda tem que ser definido
`pasta`:	`[string]`	Array de pastas
`cep`:	`string`	Cep sem o traço

Deletar um usuário

  DELETE /api/users/{id} 🔴

Parâmetro	Tipo	Descrição
_	_	_

Tag pastas

As pastas são as áreas dentro do projeto como por exemplo: saúde, educação segurança, entre outros.

Retorna todas as pastas

  GET /api/pastas 🔵

Parâmetro	Tipo	Descrição
_	_	_

Retorna uma única pasta com base no id

  GET /api/pastas/{id} 🔵

Parâmetro	Tipo	Descrição
_	_	_

Criação de uma nova pasta

  POST /api/pastas 🟢

Parâmetro	Tipo	Descrição
`name`	`string`	Obrigatório. Nome do da pasta

Atualização de uma pasta previamente cadastrada

  POST /api/pastas/{id} 🟡

Parâmetro	Tipo	Descrição
`name`	`string`	Nome da pasta

Deletar um pasta

  DELETE /api/pastas/{id} 🔴

Parâmetro	Tipo	Descrição
_	_	_

Referência

Scripts do projeto

Para fazer o deploy desse projeto rode

Instalação

$ npm install

Rodando o app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Teste

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Documentação

Roadmap

Melhorar o suporte de navegadores
Adicionar mais integrações

car1nhanha / gestor-backend Goto Github PK

gestor-backend's Introduction