Sobre o Projeto

Eu me deparei em um senário no qual após 4 anos trabalhando com dev PHP/Laravel, eu não sabia documentar uma API usando swagger, então resolvi me aventurar e aprender de uma vez por todas, me desafie criando essa mini api para pôr em prática tudo que aprendi, meu próximo passo agora vai ser integrar a bateria de testes usado o PestPhp

Dependências

• L5-Swagger.
• Swagger-PHP
• Pest

Requisitos

• PHP (>= 8.2)
• Composer
• Docker

Instalação

1. Clone esse repositorio em sua máquina local

   git clone https://github.com/CaiqueDeveloper/api-with-swagger.git

2. Na pasta do projeto excute o composer

   composer install

3. Agora suba os container usando o sail

   ./vendor/bin/sail up ou sail up

4. Agora suba as migrations

      sail artisan migrate

Funcionalidade do sistema

Auth

• Register
• login
• Logout

User

• Register User
• Update User
• Delete User

Todos

• Register Todo
• Get All Todos
• Get Todo
• Update Todo
• Delete Todo

Test

• Register
• login
• Logout
• Register User
• Update User
• Delete User
• Register Todo
• Get All Todos
• Get Todo
• Update Todo
• Delete Todo

Security Vulnerabilities

If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [email protected]. All security vulnerabilities will be promptly addressed.

License

The Laravel framework is open-sourced software licensed under the MIT license.