Bem-vindo à documentação da API de Controle Financeiro Pessoal. Esta API foi desenvolvida utilizando a tecnologia .NET 7 e é projetada para ajudar você a gerenciar suas finanças pessoais. Esta documentação fornecerá informações sobre as tecnologias utilizadas, os pré-requisitos e instruções para executar a API usando Docker e Docker Compose.
- .NET 7: Uma plataforma de desenvolvimento multiplataforma para criar aplicativos modernos e escaláveis.
- Docker: Uma plataforma para desenvolvimento, envio e execução de aplicativos em contêineres.
- Docker Compose: Uma ferramenta para definir e executar aplicativos Docker multi-container.
- SQL Server: Um banco de dados relacional utilizado para armazenar dados da aplicação.
- Autenticação JWT: A API inclui um sistema de autenticação baseado em JSON Web Tokens (JWT) para proteger as transações financeiras pessoais. O JWT é utilizado para autenticar os usuários e controlar o acesso aos recursos da API de forma segura.
Antes de executar a API de Controle Financeiro Pessoal, verifique se você possui os seguintes pré-requisitos instalados em seu sistema:
-
Docker: Certifique-se de que o Docker esteja instalado em seu sistema. Você pode baixar e instalar o Docker a partir do site oficial.
-
Docker Compose: Certifique-se de que o Docker Compose esteja instalado em seu sistema. O Docker Compose é geralmente instalado automaticamente quando você instala o Docker.
Para obter o código-fonte da API de Controle Financeiro Pessoal e começar a trabalhar com ele, você pode clonar o repositório do GitHub. Siga as etapas abaixo:
-
Abra um terminal ou prompt de comando em seu sistema.
-
Execute o seguinte comando para clonar o repositório:
git clone https://github.com/AlarconVinicius/proj-controle-financeiro-api.gitIsso irá baixar o código-fonte da API para o seu sistema local.
- Navegue até o diretório clonado usando o comando cd:
cd ProjControleFinanceiro-
Abra um terminal na raiz do projeto onde está localizado o arquivo
docker-compose.yml. -
Execute o seguinte comando para iniciar a API usando o Docker Compose:
docker-compose upA API será compilada e implantada em um contêiner Docker. Você poderá acessá-la em http://localhost:8001/swagger/index.html.
Nota: Ao iniciar a aplicação pela primeira vez, um perfil de administrador é criado automaticamente com as seguintes informações:
- Nome: Usuário
- Sobrenome: Administrador
- Número de Telefone: (99) 99999-9999
- E-mail: admin@controlefinanceiro.com
- Senha: Admin@123
-
- Endpoint: POST /api/auth/registrar
Descrição: Registra um novo usuário na aplicação.
- name (string): Nome do usuário.
- lastName (string): Sobrenome do usuário.
- phoneNumber (string): Número de telefone do usuário.
- email (string): Endereço de e-mail do usuário.
- password (string): Senha do usuário.
- confirmPassword (string): Confirmação de senha do usuário.
{
"name": "string",
"lastName": "string",
"phoneNumber": "string",
"email": "string",
"password": "string",
"confirmPassword": "string"
}Corpo da resposta:
{
"success": true,
"data": null
}-
- Endpoint: POST /api/auth/autenticar
Descrição: Autentica um usuário na aplicação.
- email (string): Endereço de e-mail do usuário.
- password (string): Senha do usuário.
Corpo da resposta:
- accessToken (string): Token de acesso gerado após a autenticação.
- expiresIn (int): Tempo de expiração do token em segundos.
- usuarioToken (objeto): Objeto contendo informações do usuário autenticado.
- id (string): ID do usuário.
- email (string): Endereço de e-mail do usuário.
- claims (array de objetos): Lista de reivindicações (claims) associadas ao usuário autenticado.
- value (string): Valor da reivindicação.
- type (string): Tipo da reivindicação.
{
"success": true,
"data": {
"accessToken": "string",
"expiresIn": 0,
"usuarioToken": {
"id": "string",
"email": "string",
"claims": [
{
"value": "string",
"type": "string"
}
]
}
}
}Corpo da resposta:
{
"success": false,
"errors": {
"additionalProp1": ["string"],
"additionalProp2": ["string"],
"additionalProp3": ["string"]
}
}-
- Endpoint: POST /api/transactions
Descrição: Adiciona uma nova transação.
- clienteId (Guid): ID do cliente que está realizando a transação.
- descricao (string): Descrição da transação.
- valor (decimal): Valor da transação.
- data (string): Data da transação no formato "dd/MM/yyyy".
- tipoTransacao (int): Tipo da transação. Opções disponíveis:
- Receita (1): Transação de receita.
- Despesa (2): Transação de despesa.
- categoria (int): Categoria da transação. Opções disponíveis:
- Lazer (1)
- Restaurantes (2)
- Viagem (3)
- Educacao (4)
- Vestuario (5)
- Saúde (6)
- Cartao (7)
- Salario (8)
- Casa (9)
- Mercado (10)
- Servicos (11)
- Assinaturas (12)
- Pets (13)
- Investimentos (14)
- Transporte (15)
- Presentes (16)
- Outros (17)
- pago (bool): Indica se a transação foi paga (true) ou não (false).
- repete (bool): Indica se a transação é uma transação repetitiva (true) ou não (false).
- qtdRepeticao (int): Quantidade de repetições da transação (aplicável apenas se "repete" for true).
{
"clienteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"descricao": "string",
"valor": 0,
"data": "dd/MM/yyyy",
"tipoTransacao": 1,
"categoria": 1,
"pago": false,
"repete": false,
"qtdRepeticao": 0
}Corpo da resposta:
{
"success": true,
"data": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"descricao": "string",
"valor": 0,
"data": "dd/MM/yyyy",
"tipoTransacao": {
"id": 0,
"tipoTransacao": "string"
},
"categoria": {
"id": 0,
"categoria": "string"
},
"pago": true,
"pagoRelatorio": "string"
}
}-
- Endpoint: GET /api/transactions/{id}
Descrição: Obtém uma transação pelo seu ID.
- id (Guid): ID da transação a ser obtida.
Corpo da resposta:
{
"success": true,
"data": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"descricao": "string",
"valor": 0,
"data": "dd/MM/yyyy",
"tipoTransacao": {
"id": 0,
"tipoTransacao": "string"
},
"categoria": {
"id": 0,
"categoria": "string"
},
"pago": true,
"pagoRelatorio": "string"
}
}-
- Endpoint: GET /api/transactions
Descrição: Obtém todas as transações.
Corpo da resposta:
{
"success": true,
"data": {
"entrada": 0,
"saida": 0,
"saldo": 0,
"transacoes": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"descricao": "string",
"valor": 0,
"data": "dd/MM/yyyy",
"tipoTransacao": {
"id": 0,
"tipoTransacao": "string"
},
"categoria": {
"id": 0,
"categoria": "string"
},
"pago": true,
"pagoRelatorio": "string"
}
]
}
}-
- Endpoint: GET /api/transactions/mes-ano
Descrição: Obtém todas as transações de um respectivo mês e ano.
- mes (int): Mês desejado.
- ano (int): Ano desejado.
Corpo da resposta:
{
"success": true,
"data": {
"entrada": 0,
"saida": 0,
"saldo": 0,
"transacoes": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"descricao": "string",
"valor": 0,
"data": "dd/MM/yyyy",
"tipoTransacao": {
"id": 0,
"tipoTransacao": "string"
},
"categoria": {
"id": 0,
"categoria": "string"
},
"pago": true,
"pagoRelatorio": "string"
}
]
}
}-
- Endpoint: PUT /api/transactions
Descrição: Atualiza uma transação existente.
- id (Guid): ID da transação a ser atualizada.
- descricao (string): Nova descrição da transação.
- valor (decimal): Novo valor da transação.
- data (string): Nova data da transação no formato "dd/MM/yyyy".
- tipoTransacao (int): Novo tipo da transação (1 para débito, 2 para crédito, etc.).
- categoria (int): Nova categoria da transação (1 para alimentação, 2 para moradia, etc.).
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"descricao": "string",
"valor": 0,
"data": "dd/MM/yyyy",
"tipoTransacao": 1,
"categoria": 1
}Corpo da resposta:
{
"success": true,
"data": null
}-
- Endpoint: PATCH /api/transactions/{id}/pago
Descrição: Atualiza o status de pagamento de uma transação.
-
id (Guid): ID da transação a ser atualizada.
-
pago (bool): Valor booleano indicando se a transação foi paga ou não.
Corpo da resposta:
{
"success": true,
"data": null
}-
- Endpoint: DELETE /api/transactions/{id}
Descrição: Deleta uma transação.
- id (Guid): ID da transação a ser deletada.
Corpo da resposta:
{
"success": true,
"data": null
}Corpo da resposta:
{
"success": false,
"errors": {
"additionalProp1": ["string"],
"additionalProp2": ["string"],
"additionalProp3": ["string"]
}
}-
- Endpoint: POST /api/relatorios
Descrição: Gera um arquivo PDF com base em um filtro de transações especificado.
-
De (string, opcional, padrão: "dd/MM/yyyy"): Data de início do período de filtro no formato "dd/MM/yyyy".
-
Ate (string, opcional, padrão: "dd/MM/yyyy"): Data de fim do período de filtro no formato "dd/MM/yyyy".
-
Mes (int, opcional, padrão: "Entre 1 e 12"): Número do mês para filtro.
-
Ano (int, opcional, padrão: "yyyy"): Ano para filtro.
-
CicloPdfDto (enum, obrigatório): Ciclo de geração do relatório PDF. Opções disponíveis:
- Período (1): Gera o relatório para um período específico.
- Mensal (2): Gera o relatório mensalmente.
- Anual (3): Gera o relatório anualmente.
Corpo da resposta:
O arquivo PDF gerado será retornado como resposta.Corpo da resposta:
{
"success": false,
"errors": {
"additionalProp1": ["string"],
"additionalProp2": ["string"],
"additionalProp3": ["string"]
}
}-
- Endpoint: GET /api/usuarios/{id}
Descrição: Obtém as informações de um usuário com base no ID fornecido.
- id (Guid): ID do usuário a ser obtido.
Corpo da resposta:
{
"success": true,
"data": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"roles": [
"string"
]
}
}-
- Endpoint: GET /api/usuarios
Descrição: Obtém a lista de todos os usuários. Apenas os administradores têm acesso a este endpoint.
Corpo da resposta:
{
"success": true,
"data": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"roles": [
"string"
]
}
]
}-
- Endpoint: PUT /api/usuarios
Descrição: Atualiza as informações de um usuário.
- id (string): Este é o ID único do usuário que você deseja atualizar. O ID identifica o usuário específico que será modificado.
- name (string): Este campo representa o novo nome do usuário. Você pode fornecer uma nova string que substituirá o nome existente do usuário.
- lastName (string): Este campo representa o novo sobrenome do usuário. Da mesma forma, você pode fornecer uma nova string para substituir o sobrenome existente.
- email (string): Este campo é usado para atualizar o endereço de e-mail do usuário. Você pode fornecer uma nova string de e-mail que substituirá o endereço de e-mail atual.
- phoneNumber (string): Este campo é destinado a atualizar o número de telefone do usuário. Assim como nos campos anteriores, você pode fornecer um novo número de telefone para substituir o número atual.
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string"
}Corpo da resposta:
{
"success": true,
"data": null
}-
- Endpoint: PATCH /api/usuarios/{userId}/bloqueio
Descrição: Altera o status de bloqueio de um usuário com base no ID do usuário fornecido.
- userId (Guid): ID do usuário a ser atualizado.
- bloquear (bool): Indica se o usuário deve ser bloqueado (true) ou desbloqueado (false).
Corpo da resposta:
{
"success": true,
"data": null
}-
- Endpoint: DELETE /api/usuarios/{userId}
Descrição: Deleta um usuário com base no ID do usuário fornecido.
- userId (Guid): ID do usuário a ser deletado.
Corpo da resposta:
{
"success": true,
"data": null
}Corpo da resposta:
{
"success": false,
"errors": {
"additionalProp1": ["string"],
"additionalProp2": ["string"],
"additionalProp3": ["string"]
}
}-
- Endpoint: GET /api/enum/categorias
Descrição: Este endpoint permite obter as opções disponíveis para o enum de categorias. Retorna as opções disponíveis para o enum de categorias de transações.
Corpo da resposta:
{
"success": true,
"data": [
{
"value": 1,
"name": "string"
},
{
"value": 2,
"name": "string"
}
]
}-
- Endpoint: GET /api/enum/tipos-transacao
Descrição: Este endpoint permite obter as opções disponíveis para o enum de tipos de transação. Retorna as opções disponíveis para o enum de tipos de transação.
Corpo da resposta:
{
"success": true,
"data": [
{
"value": 1,
"name": "string"
},
{
"value": 2,
"name": "string"
}
]
}Certifique-se de consultar a documentação detalhada da API para obter informações sobre como usar cada rota.
Para obter informações mais detalhadas sobre como usar a API de Controle Financeiro Pessoal, consulte a documentação fornecida junto com o código-fonte.
Esta documentação serve como um guia básico para configurar e executar a API de Controle Financeiro Pessoal. Certifique-se de adaptar as configurações e instruções de acordo com suas necessidades específicas e ambiente de desenvolvimento.
- Portfólio: Link para o seu Portfólio
- LinkedIn: Link para o seu LinkedIn