Skip to content

Latest commit

 

History

History
113 lines (77 loc) · 2.32 KB

README.md

File metadata and controls

113 lines (77 loc) · 2.32 KB

Documentação do Projeto Laravel com Docker

Este é um guia de configuração para um projeto Laravel usando Docker e Autenticação JWT. O projeto utiliza um ambiente Dockerizado para facilitar a configuração e execução.

Instalação do projeto

Clone o repositório:

git clone https://github.com/selogerkkk/desafioBackend.git

Copie o arquivo de ambiente:

cp .env.example .env

Instale as dependências do Laravel com o Composer:

composer install

Gere a chave de aplicação:

php artisan key:generate

Gere a chave JWT:

php artisan jwt:secret -f

Configuração do Docker

Construa os contêineres Docker:

./vendor/bin/sail build
# ou
sail build

Execute os contêineres Docker:

./vendor/bin/sail up
# ou
sail up

Configuração do Banco de Dados

Rode as migrações para configurar o banco de dados:

sail artisan migrate:fresh

Problema de Permissão

Se encontrar o erro "Failed to open stream: Permission denied", execute:

chmod -R guo+w storage

Documentação da API

A documentação da API é feita usando o Swagger. Para visualizar a documentação usando a SwaggerUI, acesse Swagger Documentation.

Usuário de Teste

Um usuário de teste foi criado para fins de teste. As informações do usuário são as seguintes:

  • Email: admin@admin.com
  • Senha: admin123

Endpoints

1. Listar todas as ferramentas

  • Método: GET
  • Rota: /tools
  • Descrição: Retorna a lista de todas as ferramentas cadastradas.

2. Filtrar ferramentas por tag

  • Método: GET
  • Rota: /tools?tag=node
  • Descrição: Retorna as ferramentas filtradas pela tag especificada.

3. Cadastrar uma nova ferramenta

  • Método: POST

  • Rota: /tools

  • Descrição: Adiciona uma nova ferramenta ao repositório. O corpo da requisição deve conter as informações da ferramenta.

    Exemplo de corpo da requisição:

    {
    "title": "hotel",
    "link": "https://github.com/typicode/hotel",
    "description": "Local app manager...",
    "tags":["node", "organizing", "webapps", "domain", "developer", "https", "proxy"]
}

4. Remover uma ferramenta por ID

  • Método: POST
  • Rota: /tools/:id
  • Descrição: Remove a ferramenta com o ID especificado.