Documentação do CRUD de Startups

Documentação Geral da API

Essa API foi desenvolvida usando o Laravel e implementa um sistema para gerenciar usuários, startups e proposalss de investimentos. A seguir, apresentamos a estrutura geral e os endpoints que a API oferece, bem como as instruções para autenticação e exemplos de uso. Lembre-se de usar o Bearer Token nas requisições

Estrutura do Projeto

O projeto está dividido em três áreas principais:

Autenticação (AuthController): Gerencia a autenticação do usuário, login, logout e a obtenção de dados do usuário autenticado.
Usuários (UsersController): Gerencia as operações CRUD para usuários no sistema.
Tipos de úsuarios: : Comum, 2: Investidor, 3: Startup, 4: Admin.
Startups (StartupController): Gerencia as operações CRUD para startups, incluindo a criação e manipulação de informações sobre as startups.
Proposals (ProposalsController): Gerencia as operações CRUD para proposalss, associando usuários e startups para investimento.

API - Gerenciamento de Usuários

Esta API permite a criação, listagem, exibição, atualização e exclusão de usuários no sistema. Todas as rotas, exceto a criação de usuário, requerem autenticação via token gerado pelo Laravel Sanctum.

1. Criar um Novo Usuário

Endpoint: /create-user
Método: POST
Autenticação: Não é necessária (público)

Requisição:

{
  "name": "Novo Usuário",
  "email": "usuario@exemplo.com",
  "password": "senha_do_usuario"
}

Resposta:

{
  "message": "Usuário criado com sucesso!",
  "user": {
    "id": 1,
    "name": "Novo Usuário",
    "email": "usuario@exemplo.com",
    "created_at": "2024-01-01T12:00:00",
    "updated_at": "2024-01-01T12:00:00"
  }
}

Descrição da Resposta:

message: Confirmação de criação bem-sucedida.
user: Objeto contendo os dados do usuário criado.

2. Listar Todos os Usuários

Endpoint: /users
Método: GET
Autenticação: Requer o token de acesso

Resposta:

[
  {
    "id": 1,
    "name": "Nome do Usuário",
    "email": "usuario@exemplo.com",
    "created_at": "2024-01-01T12:00:00",
    "updated_at": "2024-01-01T12:00:00"
  }
]

Descrição da Resposta:

id: ID do usuário.
name: Nome do usuário.
email: E-mail do usuário.
created_at: Data de criação.
updated_at: Data da última atualização.

3. Exibir Dados de um Usuário

Endpoint: /users/{id}
Método: GET
Autenticação: Requer o token de acesso

Resposta:

{
  "id": 1,
  "name": "Nome do Usuário",
  "email": "usuario@exemplo.com",
  "created_at": "2024-01-01T12:00:00",
  "updated_at": "2024-01-01T12:00:00"
}

Descrição da Resposta:

id: ID do usuário.
name: Nome do usuário.
email: E-mail do usuário.
created_at: Data de criação.
updated_at: Data da última atualização.

4. Atualizar Dados de um Usuário

Endpoint: /users/{id}/edit
Método: POST
Autenticação: Requer o token de acesso

Requisição:

{
  "name": "Nome Atualizado",
  "email": "novo_email@exemplo.com"
}

Resposta:

{
  "message": "Usuário atualizado com sucesso!",
  "user": {
    "id": 1,
    "name": "Nome Atualizado",
    "email": "novo_email@exemplo.com",
    "created_at": "2024-01-01T12:00:00",
    "updated_at": "2024-01-01T12:00:00"
  }
}

Descrição da Resposta:

message: Confirmação da atualização.
user: Objeto contendo os dados do usuário atualizado.

5. Deletar um Usuário

Endpoint: /users/{id}
Método: DELETE
Autenticação: Requer o token de acesso

Resposta:

{
  "message": "Usuário deletado com sucesso.",
  "user": {
    "id": 1,
    "name": "Nome do Usuário",
    "email": "usuario@exemplo.com",
    "created_at": "2024-01-01T12:00:00",
    "updated_at": "2024-01-01T12:00:00"
  }
}

Descrição da Resposta:

message: Confirmação da exclusão.
user: Dados do usuário excluído.

StartFragment

Autenticação

A autenticação na API é feita através de tokens gerados pelo Laravel Sanctum. Após a autenticação, os usuários podem acessar rotas protegidas, como operações de CRUD de usuários e outros recursos.

1. Login do Usuário

Endpoint: /login
Método: POST
Autenticação: Não é necessária (público)

Este endpoint permite que um usuário se autentique, fornecendo suas credenciais (email e senha). Se as credenciais forem válidas, um token de acesso será gerado e retornado, permitindo que o usuário acesse rotas protegidas.

Requisição:

{
  "email": "usuario@exemplo.com",
  "password": "senha_do_usuario"
}

Resposta de Sucesso (200):

{
  "token": "seu_token_aqui",
  "token_type": "bearer",
  "expires_in": null
}

Descrição da Resposta:

token: O token de acesso gerado, que deve ser usado para autenticação nas rotas protegidas.
token_type: Tipo de token (sempre será "bearer").
expires_in: O tempo de expiração do token (no caso do Sanctum, ele não expira por padrão).

Resposta de Erro (401 - Credenciais Inválidas):

{
  "error": "Credenciais inválidas. Verifique seu email e senha."
}

2. Logout do Usuário

Endpoint: /logout
Método: POST
Autenticação: Requer o token de acesso (autenticado)

Este endpoint revoga o token de acesso do usuário, realizando o logout.

Requisição:

Nenhuma requisição adicional necessária além do token no cabeçalho.

Resposta de Sucesso (200):

{
  "message": "Usuário deslogado com sucesso"
}

Resposta de Erro (401 - Não autenticado):

{
  "error": "Token inválido ou usuário não autenticado."
}

3. Obter Dados do Usuário Autenticado

Endpoint: /user
Método: GET
Autenticação: Requer o token de acesso (autenticado)

Esse endpoint retorna as informações do usuário autenticado, permitindo que ele visualize seus próprios dados.

Resposta de Sucesso (200):

{
  "id": 1,
  "name": "Nome do Usuário",
  "email": "usuario@exemplo.com",
  "created_at": "2024-01-01T12:00:00",
  "updated_at": "2024-01-01T12:00:00"
}

Resposta de Erro (401 - Não autenticado):

{
  "error": "Usuário não autenticado."
}

Documentação do CRUD de Startups

Esta seção descreve os endpoints da API responsáveis pela criação, leitura, atualização e exclusão de startups no sistema. As rotas de startups são protegidas e requerem autenticação, utilizando Laravel Sanctum para garantir a segurança e o controle de acesso.

CRUD de Startups

Esses endpoints permitem o gerenciamento de startups no sistema, incluindo listagem, criação, visualização, atualização e exclusão.

1. Listar Todas as Startups

Endpoint: /all-startup
Método: GET
Autenticação: Requer o token de acesso (autenticado) com permissão de startup

Este endpoint retorna todas as startups cadastradas no sistema.

Resposta de Sucesso (200):

[
  {
    "id": 1,
    "title": "Startup Exemplo",
    "description": "Descrição da startup.",
    "tempo_disponivel": "6 meses",
    "tecnologias": ["PHP", "Laravel", "MySQL"],
    "contato_informacao": "contato@startup.com",
    "licenca": "MIT",
    "tags": ["tecnologia", "inovação"],
    "user_id": 1,
    "created_at": "2024-01-01T12:00:00",
    "updated_at": "2024-01-01T12:00:00"
  }
]

2. Criar uma Nova Startup

Endpoint: /create-startup
Método: POST
Autenticação: Requer o token de acesso (autenticado) com permissão de startup

Requisição:

{
  "title": "Nova Startup",
  "description": "Descrição da nova startup.",
  "tempo_disponivel": "12 meses",
  "tecnologias": ["React", "Node.js"],
  "contato_informacao": "contato@novastartup.com",
  "licenca": "Apache-2.0",
  "tags": ["inovação", "tecnologia"],
  "user_id": 1
}

Resposta de Sucesso (201):

{
  "message": "Startup criada com sucesso!",
  "startup": {
    "id": 1,
    "title": "Nova Startup",
    "description": "Descrição da nova startup.",
    "tempo_disponivel": "12 meses",
    "tecnologias": ["React", "Node.js"],
    "contato_informacao": "contato@novastartup.com",
    "licenca": "Apache-2.0",
    "tags": ["inovação", "tecnologia"],
    "user_id": 1,
    "created_at": "2024-01-01T12:00:00",
    "updated_at": "2024-01-01T12:00:00"
  }
}

3. Exibir uma Startup Específica

Endpoint: /startup/{id}
Método: GET
Autenticação: Requer o token de acesso (autenticado)

Resposta de Sucesso (200):

{
  "id": 1,
  "title": "Startup Exemplo",
  "description": "Descrição da startup.",
  "tempo_disponivel": "6 meses",
  "tecnologias": ["PHP", "Laravel", "MySQL"],
  "contato_informacao": "contato@startup.com",
  "licenca": "MIT",
  "tags": ["tecnologia", "inovação"],
  "user_id": 1,
  "created_at": "2024-01-01T12:00:00",
  "updated_at": "2024-01-01T12:00:00"
}

4. Atualizar Dados de uma Startup

Endpoint: /startup/{id}/edit
Método: PUT
Autenticação: Requer o token de acesso (autenticado)

Requisição:

{
  "title": "Startup Atualizada",
  "description": "Descrição da startup atualizada.",
  "tempo_disponivel": "24 meses",
  "tecnologias": ["PHP", "Laravel", "Vue.js"],
  "contato_informacao": "contato@startupatualizada.com",
  "licenca": "MIT",
  "tags": ["tecnologia", "inovação", "frontend"]
}

Resposta de Sucesso (200):

{
  "message": "Startup atualizada com sucesso!",
  "startup": {
    "id": 1,
    "title": "Startup Atualizada",
    "description": "Descrição da startup atualizada.",
    "tempo_disponivel": "24 meses",
    "tecnologias": ["PHP", "Laravel", "Vue.js"],
    "contato_informacao": "contato@startupatualizada.com",
    "licenca": "MIT",
    "tags": ["tecnologia", "inovação", "frontend"],
    "user_id": 1,
    "created_at": "2024-01-01T12:00:00",
    "updated_at": "2024-01-02T12:00:00"
  }
}

5. Excluir uma Startup

Endpoint: /startup/{id}
Método: DELETE
Autenticação: Requer o token de acesso (autenticado)

Resposta de Sucesso (200):

{
  "message": "Startup deletada com sucesso."
}

6. Excluir uma Startup em Grupo

Endpoint: /startup/{id}/group
Método: DELETE
Autenticação: Requer o token de acesso (autenticado)

Resposta de Sucesso (200):

{
  "message": "Startups deletadas com sucesso."
}

Documentação da API - Propostas

Introdução

Esta API permite a criação, visualização, atualização e exclusão de propostas. As operações são realizadas no modelo Proposals, que contém informações sobre investimentos, usuários e startups. A seguir, descrevemos cada um dos endpoints disponíveis na API.