Public
Documentation Settings
No Environment
Double Column
cURL - cURL
Laravel Playground
Introduction
API Resource
Simple Search
Advanced Search

Laravel Playground

Laravel with Repository & Service Pattern Implementation

Setup

  • Run git clone https://github.com/marco-bizmatesph/laravel-playground.git to clone the project
  • Run composer install in the root directory of the project.
  • Copy the .env.example contents to .env
  • Set the database config in your .env file
  • Run php artisan migrate --seed to build the database and seed the initial data.
  • Run php artisan key:generate to generate keys for the project
  • Run php artisan serve to launch the application.
  • The project includes Telescope out of the box. This will allow you to see incoming requests and review how the queries are executed in the database. To access this, simple go to /telescope in the browser.

API Resource

The API Resource is the most common API endpoints showcasing to listing of all records, showing of a single record by id, creating a new record, updating an existing record, and deleting a record.

GETIndex

http://laravel-playground.local/api/user

Display a listing of the resource.

SQL Query:

Plain Text
select * from `users` where `users`.`deleted_at` is null
HEADERS
Accept

application/json

Example Request
Index
curl
curl --location 'http://laravel-playground.local/api/user' \
--header 'Accept: application/json'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

GETShow

http://laravel-playground.local/api/user/1

Display the specified resource.

SQL query:

Plain Text
select * from `users` where `users`.`id` = '1' and `users`.`deleted_at` is null limit 1
HEADERS
Accept

application/json

Example Request
Show
curl
curl --location 'http://laravel-playground.local/api/user/1' \
--header 'Accept: application/json'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

POSTStore

http://laravel-playground.local/api/user

Store a newly created resource in storage.

SQL Query:

Plain Text
insert into
  `users` (
    `name`,
    `email`,
    `password`,
    `updated_at`,
    `created_at`
  )
values
  (
    'Elizabeth Christiansen Sr.',
    'egibson@example.com',
    'password',
    '2020-02-27 02:49:55',
    '2020-02-27 02:49:55'
  )
HEADERS
Content-Type

application/x-www-form-urlencoded

Accept

application/json

Bodyurlencoded
name

Elizabeth Christiansen Sr.

email

egibson@example.com

password

password

password_confirmation

password

Example Request
Store
curl
curl --location 'http://laravel-playground.local/api/user' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Accept: application/json' \
--data-urlencode 'name=Elizabeth Christiansen Sr.' \
--data-urlencode 'email=egibson@example.com' \
--data-urlencode 'password=password' \
--data-urlencode 'password_confirmation=password'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers