ATHENAS CRUD - RESTFull API e CRUD

Index

About Repository

This repository is a project of a API RESTful with Laravel 8. The project is a CRUD of Clients.

Tech Specification

• PHP 8.1
• Laravel 10
• MySQL 8
• Docker with Laravel Sail
• PHPUnit 10

Features

• Pessoas:
  • POST, PUT, PATCH, GET List with Pagination, GET with id, Delete
• Categorias:
  • POST, PUT, PATCH, GET List with Pagination, GET with id, Delete

Install with Docker

• docker-compose up -d
• docker exec -it api-tdd /bin/bash
• composer install
• cp .env.example .env
• php artisan key:generate
• php artisan migrate
• php artisan db:seed
• php artisan serve
• Local http://localhost:8000/

Unit Test

run PHPUnit in local

# run PHPUnit all test cases
vendor/bin/phpunit
# Feature test only
vendor/bin/phpunit --testsuite Feature
# Unit test only
vendor/bin/phpunit --testsuite Unit

Postman Documentation

Access: Athenas CRUD - Documentation Postman

API Endpoints

• Pessoas:
  • POST
    • /api/pessoas
  • PUT
    • /api/pessoas/
  • PATCH
    • /api/pessoas/
  • GET List with Pagination
    • /api/pessoas
  • GET one
    • /api/pessoas/
  • Delete
    • /api/pessoas/
• Categorias:
  • POST
    • /api/categorias
  • PUT
    • /api/categorias/
  • PATCH
    • /api/categorias/
  • GET List with Pagination
    • /api/categorias
  • GET with id
    • /api/categorias/
  • Delete
    • /api/categorias/