Skip to content

MarsoL4/workwell-api-cloud

BranchesTags

Repository files navigation

WorkWell API - Plataforma de Bem-Estar Corporativo

👤 Integrantes

  • Enzo Giuseppe Marsola – RM: 556310, Turma: 2TDSPK
  • Rafael de Souza Pinto – RM: 555130, Turma: 2TDSPY
  • Luiz Paulo F. Fernandes – RM: 555497, Turma: 2TDSPF

📋 Sobre o Projeto

WorkWell é uma API .NET 8.0 desenvolvida para gerenciar o bem-estar emocional e psicológico de funcionários em empresas. A plataforma oferece funcionalidades como avaliações emocionais, consultas psicológicas, atividades de bem-estar, enquetes, denúncias anônimas e indicadores de saúde mental organizacional.

🏗️ Arquitetura

Arquitetura Pós-Deploy da WorkWell API:

Arquitetura Pós-Deploy da WorkWell API

Observações sobre o Diagrama

Este diagrama representa integralmente o deploy e o fluxo da solução WorkWell API:

  • Todos os recursos em nuvem (Resource Group, Azure SQL Database, Azure Web App) são provisionados via script CLI e inicializados com o script-bd.sql.
  • As configurações de segurança (API Keys, Connection String) são gerenciadas por Variable Groups (Secrets) do Azure DevOps, nunca expostas no código-fonte.
  • Azure DevOps Boards são utilizados para rastrear e vincular Work Items aos commits, branches e Pull Requests; toda entrega ou alteração passa pelo fluxo de ALM.
  • O repositório Git (Azure Repos) armazena o código-fonte, o histórico de branch, merges e oferece proteção de branch principal (main), com políticas de revisor obrigatório e vinculação de Work Item.
  • Build Pipeline é acionada exclusivamente após merge via PR na main, nunca por commits diretos, garantindo validação automatizada e publicação de artefatos/resultados de testes (XUnit).
  • Release Pipeline é acionada automaticamente após Build, realizando deploy contínuo no Azure Web App PaaS, configurando secrets, settings e connection strings direto no ambiente cloud.
  • Após o deploy, valida-se o ambiente via endpoint de health check, garantindo monitoramento CI/CD.
  • O Web App consome configurações de ambiente e secrets, conecta-se de forma segura ao Azure SQL Database (PaaS), e nunca expõe dados sensíveis no appsettings.json.
  • Todo fluxo de autenticação (API Key e roles), rastreamento, persistência (EF Core) e endpoints (CRUD/REST) estão documentados e implementados conforme os requisitos de entrega.
  • Não há containers nem ACR/ACI – a solução é 100% PaaS e está alinhada ao padrão exigido.

O diagrama detalha visualmente a integração entre DevOps, Cloud, Segurança, Infraestrutura, CI/CD automatizado, monitoramento e a estrutura de serviços e controllers da aplicação.

🚀 Tecnologias

  • .NET 8.0 - Framework principal
  • Entity Framework Core - ORM
  • Azure SQL Database - Banco de dados (PaaS)
  • Azure Web App - Hospedagem (PaaS)
  • XUnit - Framework de testes
  • Swagger/OpenAPI - Documentação da API
  • Azure DevOps - CI/CD e gerenciamento

📦 Estrutura do Projeto

WorkWell.sln
├── WorkWell.API/                # Camada de apresentação (Controllers, Middleware)
├── WorkWell.Application/        # Camada de aplicação (Services, DTOs)
├── WorkWell.Domain/             # Camada de domínio (Entities, Interfaces)
├── WorkWell.Infrastructure/     # Camada de infraestrutura (Repositories, DbContext)
├── WorkWell.Tests/              # Testes unitários (XUnit)
├── scripts/                     # Scripts de infraestrutura e banco
│   ├── script-infra-deploy.sh
│   └── script-bd.sql
├── azure-pipeline-build.yml     # Pipeline de Build (raiz)
├── azure-pipeline-release.yml   # Pipeline de Release (raiz)

Observação:
O projeto não faz uso de containerização Docker no deploy em nuvem, optando totalmente por recursos PaaS (App Service + Azure SQL).

🔐 Autenticação

A API utiliza API Keys para autenticação. Cada perfil possui uma chave específica:

  • Admin: Acesso total ao sistema
  • RH: Gestão de funcionários e setores
  • Psicologo: Acesso a consultas e avaliações
  • Funcionario: Acesso limitado ao próprio perfil

Headers Obrigatórios

X-API-Key: <sua-api-key>

📚 Endpoints CRUD - Exemplos JSON

1. Empresa (EmpresaController)

CREATE - POST /api/v1/Empresa

Request:

{
  "nome": "Futuro do Trabalho Ltda",
  "emailAdmin": "admin@futurework.com",
  "senhaAdmin": "admin123",
  "tokenAcesso": "token-ftw-001",
  "logoUrl": "https://futurework.com/logo.png",
  "corPrimaria": "#1F77B4",
  "corSecundaria": "#FFB800",
  "missao": "Transformar o bem-estar no ambiente de trabalho.",
  "politicaBemEstar": "Aqui o respeito e o cuidado são prioridades!"
}

Response (201 Created):

{
  "id": 1,
  "nome": "Futuro do Trabalho Ltda",
  "emailAdmin": "admin@futurework.com",
  "senhaAdmin": "admin123",
  "tokenAcesso": "token-ftw-001",
  "logoUrl": "https://futurework.com/logo.png",
  "corPrimaria": "#1F77B4",
  "corSecundaria": "#FFB800",
  "missao": "Transformar o bem-estar no ambiente de trabalho.",
  "politicaBemEstar": "Aqui o respeito e o cuidado são prioridades!"
}

READ - GET /api/v1/Empresa/{id}

Response (200 OK):

{
  "id": 1,
  "nome": "Futuro do Trabalho Ltda",
  "emailAdmin": "admin@futurework.com",
  "senhaAdmin": "admin123",
  "tokenAcesso": "token-ftw-001",
  "logoUrl": "https://futurework.com/logo.png",
  "corPrimaria": "#1F77B4",
  "corSecundaria": "#FFB800",
  "missao": "Transformar o bem-estar no ambiente de trabalho.",
  "politicaBemEstar": "Aqui o respeito e o cuidado são prioridades!"
}

READ ALL (Paged) - GET /api/v1/Empresa?page=1&pageSize=10

Response (200 OK):

{
  "page": 1,
  "pageSize": 10,
  "totalCount": 1,
  "totalPages": 1,
  "data": [
    {
      "id": 1,
      "nome": "Futuro do Trabalho Ltda",
      "emailAdmin": "admin@futurework.com",
      "senhaAdmin": "admin123",
      "tokenAcesso": "token-ftw-001",
      "logoUrl": "https://futurework.com/logo.png",
      "corPrimaria": "#1F77B4",
      "corSecundaria": "#FFB800",
      "missao": "Transformar o bem-estar no ambiente de trabalho.",
      "politicaBemEstar": "Aqui o respeito e o cuidado são prioridades!"
    }
  ],
  "links": {
    "self": "/api/v1/Empresa?page=1&pageSize=10",
    "first": "/api/v1/Empresa?page=1&pageSize=10",
    "last": "/api/v1/Empresa?page=1&pageSize=10"
  }
}

UPDATE - PUT /api/v1/Empresa/{id}

Request:

{
  "id": 1,
  "nome": "Futuro do Trabalho Ltda - Atualizado",
  "emailAdmin": "admin@futurework.com",
  "senhaAdmin": "admin123",
  "tokenAcesso": "token-ftw-001",
  "logoUrl": "https://futurework.com/logo-v2.png",
  "corPrimaria": "#1F77B4",
  "corSecundaria": "#FFB800",
  "missao": "Transformar o bem-estar no ambiente de trabalho - Missão Atualizada.",
  "politicaBemEstar": "Aqui o respeito e o cuidado são prioridades!"
}

Response (204 No Content)

DELETE - DELETE /api/v1/Empresa/{id}

Response (204 No Content)

2. Funcionario (FuncionarioController)

CREATE - POST /api/v1/Funcionario

Request:

{
  "nome": "Carlos Silva",
  "email": "carlos@futurework.com",
  "senha": "func123",
  "tokenEmpresa": "token-ftw-001",
  "cargo": 2,
  "ativo": true,
  "setorId": 1,
  "empresaId": 1
}

Nota: cargo é um enum:

  • 0 = Admin
  • 1 = RH
  • 2 = Funcionario
  • 3 = Psicologo

Response (201 Created):

{
  "id": 1,
  "nome": "Carlos Silva",
  "email": "carlos@futurework.com",
  "senha": "func123",
  "tokenEmpresa": "token-ftw-001",
  "cargo": 2,
  "ativo": true,
  "setorId": 1,
  "empresaId": 1
}

READ - GET /api/v1/Funcionario/{id}

Response (200 OK):

{
  "id": 1,
  "nome": "Carlos Silva",
  "email": "carlos@futurework.com",
  "senha": "func123",
  "tokenEmpresa": "token-ftw-001",
  "cargo": 2,
  "ativo": true,
  "setorId": 1,
  "empresaId": 1
}

READ ALL (Paged) - GET /api/v1/Funcionario?page=1&pageSize=10

Response (200 OK):

{
  "page": 1,
  "pageSize": 10,
  "totalCount": 1,
  "totalPages": 1,
  "data": [
    {
      "id": 0,
      "nome": "Carlos Silva",
      "email": "carlos@futurework.com",
      "senha": "func123",
      "tokenEmpresa": "token-ftw-001",
      "cargo": 2,
      "ativo": true,
      "setorId": 1,
      "empresaId": 1
    }
  ],
  "links": {
    "self": "/api/v1/Funcionario?page=1&pageSize=10",
    "first": "/api/v1/Funcionario?page=1&pageSize=10",
    "last": "/api/v1/Funcionario?page=1&pageSize=10"
  }
}

UPDATE - PUT /api/v1/Funcionario/{id}

Request:

{
  "id": 1,
  "nome": "Carlos Silva Santos",
  "email": "carlos.santos@futurework.com",
  "senha": "func123",
  "tokenEmpresa": "token-ftw-001",
  "cargo": 2,
  "ativo": true,
  "setorId": 1,
  "empresaId": 1
}

Response (204 No Content)

DELETE - DELETE /api/v1/Funcionario/{id}

Response (204 No Content)

🛠️ Configuração e Deploy

Pré-requisitos

  • Azure CLI instalado e configurado
  • Conta Azure com permissões para criar recursos em nuvem
  • Azure DevOps configurado

1. Provisionamento de Infraestrutura

Execute o script de provisionamento:

chmod +x scripts/script-infra-deploy.sh
./scripts/script-infra-deploy.sh

O script cria:

  • Resource Group
  • Azure SQL Server e Database
  • App Service Plan
  • Azure Web App (PaaS)

2. Configuração do Azure DevOps

Variáveis Secretas

Antes de rodar qualquer pipeline, é obrigatório configurar variáveis secretas usando Library → Variable Groups do Azure DevOps. Nunca exponha valores sensíveis diretamente no código, nem hardcode nos arquivos yaml.

Configure as seguintes variáveis secretas:

  • SQL_PASSWORD (Secret)
  • APIKEY_ADMIN (Secret)
  • APIKEY_RH (Secret)
  • APIKEY_PSICOLOGO (Secret)
  • APIKEY_FUNCIONARIO (Secret)
  • SUPERAPIKEY (Secret)

Service Connection

Crie uma Service Connection do tipo "Azure Resource Manager" com o nome:

  • workwell-azure-subscription

Branch Policies

Configure a branch main como protegida:

  • Revisor obrigatório
  • Vinculação de Work Item obrigatória
  • Revisor padrão coloque você mesmo

3. Pipelines

Build Pipeline

  • Arquivo: azure-pipeline-build.yml (raiz do projeto)
  • Pipeline: WorkWell API - Build
  • Definição: Executa exclusivamente após merge via PR para a branch main.
  • Validação: Roda restore, build, testes (XUnit), publica artefatos e resultados dos testes.

Release Pipeline

  • Arquivo: azure-pipeline-release.yml (raiz do projeto)
  • Pipeline: WorkWell API - Release
  • Definição: Executa automaticamente após conclusão da Build e geração de artefato.
  • Validação: Realiza deploy no Azure Web App (PaaS), configura settings e connection strings, faz health check.

🧪 Testes

Os testes são executados automaticamente na pipeline de Build usando XUnit.

Para executar manualmente:

dotnet test WorkWell.Tests/WorkWell.Tests.csproj

📊 Health Check

A API expõe um endpoint de health check para validação do ambiente em produção e CI/CD:

GET /health

📝 Documentação da API

A documentação Swagger está disponível em:

https://workwell-app.azurewebsites.net/swagger/index.html

🔒 Segurança

  • API Keys protegidas como variáveis secretas no Azure DevOps (não são expostas no repositório)
  • Connection Strings nunca ficam hardcoded; sempre via Azure App Settings e variáveis de ambiente
  • Firewall do Azure SQL configurado para permitir acesso apenas ao Web App
  • HTTPS habilitado no Azure Web App por padrão

About

Repositório utilizado para a versão de deploy da API .NET do projeto WorkWell na matéria de DevOps da 2ª Global Solution de 2025 da FIAP em parceria com a IBM e a MSF

Resources

Readme
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Contributors

Languages