vinyguedess / organo

API para gerenciamento de organograma de uma empresa

Organo

API para gerenciamento de organograma de uma empresa.
Organo

Instalação

Requerido

Ambiente básico para rodar a aplicação

• Apache2
• PHP 7
• PostgreSQL, MySQL ou MariaDB

Configurações

Primeiro é necessário criar um arquivo .env na raiz do projeto ou adicionar ao ambiente as seguintes variaveis:

• ORGANO_DB_DRIVER - Representa o driver de banco de dados que será utilizado
• ORGANO_DB_SERVIDOR
• ORGANO_DB_PORTA
• ORGANO_DB_USUARIO
• ORGANO_DB_SENHA
• ORGANO_DB_NOME - Representa o nome do banco de dados que será utilizado

Comandos

    composer install

Rotas

Rotas contempladas na API

Departamentos

• POST /api/v1/departamentos Cria um departamento
  • Formato { "departamento": { "id_departamento_pai": "ID PAI", "nome": "NOME DO USUARIO" } }
  • Info Campo id_departamento_pai não é obrigatório
• PUT /api/v1/departamentos/{id} Atualiza um departamento selecionado
  • Formato { "departamento": { "id_departamento_pai": "ID PAI", "nome": "NOME DO USUARIO" } }
  • Info Campo id_departamento_pai não é obrigatório
• GET /api/v1/departamentos Lista departamentos
  • Caso seja enviado o parâmetro recursive com valor 1 o resultado vem em formato recursivo
• GET /api/v1/departamentos/{id} Exibe os dados do departamento selecionado
• DEL /api/v1/departamentos/{id} Deleta um departamento selecionado

Usuários

• POST /api/v1/usuarios Cria um usuário
  • Formato { "usuario": { "nome": "NOME DO USUARIO", "status": "UM OU ZERO" } }
  • Info Campo status não é obrigatório
• PUT /api/v1/usuarios/{id} Atualiza um usuário selecionado
  • Formato { "usuario": { "nome": "NOME DO USUARIO", "status": "UM OU ZERO" } }
  • Info Campo status não é obrigatório
• GET /api/v1/usuarios Lista usuários
  • Aceita parâmetros limit e offset na URL para fazer paginação
• GET /api/v1/usuarios/{id} Exibe os dados do usuário selecionado
• DEL /api/v1/usuarios/{id} Deleta um usuário selecionado

Atrelar usuário à departamento

• POST /api/v1/departamentos/{dpto_id}/atrelar/{usuario_id} Atrelar o usuário selecionado ao departamento
  
• DEL /api/v1/departamentos/{dpto_id}/atrelar/{usuario_id} Desatrelar o usuário selecionado do departamento