git clone https://github.com/marco-bizmatesph/laravel-playground.git to clone the projectcomposer install in the root directory of the project..env.example contents to .env.env filephp artisan migrate --seed to build the database and seed the initial data.php artisan key:generate to generate keys for the projectphp artisan serve to launch the application./telescope in the browser.Display a listing of the resource.
\nselect * from `users` where `users`.`deleted_at` is null\nDisplay the specified resource.
\nselect * from `users` where `users`.`id` = '1' and `users`.`deleted_at` is null limit 1 \nStore a newly created resource in storage.
\ninsert into\n `users` (\n `name`,\n `email`,\n `password`,\n `updated_at`,\n `created_at`\n )\nvalues\n (\n 'Elizabeth Christiansen Sr.',\n 'egibson@example.com',\n 'password',\n '2020-02-27 02:49:55',\n '2020-02-27 02:49:55'\n )\nUpdate the specified resource in storage.
\nupdate\n `users`\nset\n `name` = 'Elizabeth Christiansen Sr.',\n `email` = 'egibson1@example.com',\n `password` = 'password',\n `users`.`updated_at` = '2020-02-27 02:51:04'\nwhere\n `id` = 1\nRemove the specified resource from storage. This operation was a soft delete.
\nupdate\n `users`\nset\n `deleted_at` = '2020-02-27 02:51:41',\n `users`.`updated_at` = '2020-02-27 02:51:41'\nwhere\n `id` = 1\nThe 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.
\n","event":[{"listen":"prerequest","script":{"id":"33a7311e-9eff-4b20-a621-8ea01c603e5b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1d4bcf97-09f6-43d8-ba7a-924fc7ab5453","type":"text/javascript","exec":[""]}}],"_postman_id":"fa76e682-777c-43a6-b490-d0bde0ff21c5"},{"name":"Simple Search","item":[{"name":"Get the first result","id":"43481004-659b-47ed-8330-d6cb210a5d40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":"http://laravel-playground.local/api/user/search?first=1","description":"select * from `users` where `users`.`deleted_at` is null limit 1 \nperPage is the number of items in a single pagination. page is the page number in the pagination based on perPage.select * from `users` where `users`.`deleted_at` is null limit 10 offset 10 \nselect * from `users` where (`name` like 'Mr.%') and `users`.`deleted_at` is null \nArray parameters will use a whereIn statement.
select\n *\nfrom\n `users`\nwhere\n (\n `name` in ('Trenton Jones', 'Miss Marie Durgan III')\n )\n and `users`.`deleted_at` is null\nselect\n *\nfrom\n `users`\nwhere\n (`id` = '2')\n and `users`.`deleted_at` is null\nArray parameters will use a in statement.
select * from `users` where (`id` in ('2', '100')) and `users`.`deleted_at` is null\nselect\n *\nfrom\n `users`\nwhere\n (`email_verified_at` = '2020-01-29 05:25:50')\n and `users`.`deleted_at` is null\nArray parameters will use in statement.
select\n *\nfrom\n `users`\nwhere\n (\n `email_verified_at` in ('2019-03-22 18:02:12', '2019-07-25 00:40:32')\n )\n and `users`.`deleted_at` is null\nBy default, the query will use or if strict is not provided.
select\n *\nfrom\n `users`\nwhere\n (\n `id` = '2'\n or `name` like 'Mr.%'\n )\n and `users`.`deleted_at` is null\nlimit\n 2 offset 0\nIf strict is specified. It will use and to combine the where statement.
select\n *\nfrom\n `users`\nwhere\n (\n `id` in ('1', '66')\n and `name` like 'Mr.%'\n )\n and `users`.`deleted_at` is null\nIf inverse is specified, if will do the opposite of the parameters.
select\n *\nfrom\n `users`\nwhere\n (`name` not like 'Mr.%')\n and `users`.`deleted_at` is null\nIf with is specified, the related model will be included in the query. Given that the relationship was declared in the model itself.
select * from `users` where (`name` like 'Mr.%') and `users`.`deleted_at` is null limit 1 \nselect * from `posts` where `posts`.`user_id` in (5) \nIf withCount is specified, the related model will be counted and attached as models_count.
select\n `users`.*,\n (\n select\n count(*)\n from\n `posts`\n where\n `users`.`id` = `posts`.`user_id`\n ) as `posts_count`\nfrom\n `users`\nwhere\n (`name` like 'Mr.%')\n and `users`.`deleted_at` is null\nlimit\n 1\nIf withTrashed is specified, records that were soft deleted will be included in the list.
select * from `users`\nIf onlyTrashed is specified, only the soft deleted records will be listed.
select * from `users` where `users`.`deleted_at` is not null \nIf orderBy is specified, it will sort the list according to the column given.
select\n *\nfrom\n `users`\nwhere\n (`name` like 'Mr.%')\n and `users`.`deleted_at` is null\norder by\n `name` asc\nlimit\n 10 offset 0\nIf descending is set to true, it will sort the list in descending order. orderBy needs to be specified.
select\n *\nfrom\n `users`\nwhere\n (`name` like 'Mr.%')\n and `users`.`deleted_at` is null\norder by\n `id` desc\nSimple search can only be accessed through a GET request. This provides the client a simpler way to fetch data from our API. This search only uses a single where statement in its query. The request cannot handle nested json in the parameter.
For numeric columns, if lessThan is specified, the query will use <.
select * from `users` where (`id` < 3) and `users`.`deleted_at` is null \nFor numeric columns, if lessThanOrEqualTo is specified, the query will use <=.
select * from `users` where (`id` <= 3) and `users`.`deleted_at` is null \nFor numeric columns, if greaterThan is specified, the query will use >.
select * from `users` where (`id` > 98) and `users`.`deleted_at` is null \nFor numeric columns, if greaterThanOrEqualTo is specified, the query will use >=.
select * from `users` where (`id` >= 98) and `users`.`deleted_at` is null \nFor numeric columns, you can use between by specifying a from and to.
select * from `users` where (`id` between 1 and 10) and `users`.`deleted_at` is null \nFor date columns, the values will be converted to a Carbon instance. If lessThan is specified, the query will use <.
select\n *\nfrom\n `users`\nwhere\n (`email_verified_at` < '2020-01-01 00:00:00')\n and `users`.`deleted_at` is null\nFor date columns, the values will be converted to a Carbon instance. If lessThanOrEqualTo is specified, the query will use <=.
select\n *\nfrom\n `users`\nwhere\n (`email_verified_at` <= '2020-01-01 00:00:00')\n and `users`.`deleted_at` is null\nlimit\n 10 offset 0\nFor date columns, the values will be converted to a Carbon instance. If greaterThan is specified, the query will use >.
select\n *\nfrom\n `users`\nwhere\n (`email_verified_at` > '2020-01-01 00:00:00')\n and `users`.`deleted_at` is null\nlimit\n 10 offset 0\nFor date columns, the values will be converted to a Carbon instance. If greaterThanOrEqualTo is specified, the query will use >=.
select\n *\nfrom\n `users`\nwhere\n (`email_verified_at` >= '2020-01-01 00:00:00')\n and `users`.`deleted_at` is null\nlimit\n 10 offset 0\nFor date columns, the values will be converted to a Carbon instance. You can use between by specifying a from and to.
select\n *\nfrom\n `users`\nwhere\n (\n `email_verified_at` between '2019-01-01 00:00:00'\n and '2020-01-01 00:00:00'\n )\n and `users`.`deleted_at` is null\nlimit\n 10 offset 0\nIf null is set to true in a column, it will use an is null query.
select * from `users` where (`email_verified_at` is null) and `users`.`deleted_at` is null limit 1 \nIf null is set to false in a column, it will use an is not null query.
select\n *\nfrom\n `users`\nwhere\n (`email_verified_at` is not null)\n and `users`.`deleted_at` is null\nlimit\n 1\nTo set multiple conditions, just add another object in the where array. Each item will be evaluated in a separate closure.
select\n *\nfrom\n `users`\nwhere\n (\n `name` like 'Mr.%'\n or `email` like '%@example.net%'\n )\n and (`email_verified_at` is null)\n and `users`.`deleted_at` is null\nlimit\n 10 offset 0\nTo set the conditions inside a closure to only use and, you need to set strict to true in the item.
select\n *\nfrom\n `users`\nwhere\n (\n `name` like 'Mr.%'\n and `email` like '%@example.net%'\n )\n and (`email_verified_at` is not null)\n and `users`.`deleted_at` is null\nlimit\n 10 offset 0\nIf inverse is specified, if will do the opposite of the parameters.
select\n *\nfrom\n `users`\nwhere\n (`name` not like 'Mr.%')\n and (`email_verified_at` is null)\n and `users`.`deleted_at` is null\nlimit\n 10 offset 0\nTo filter related data results, you can add where in the with array.
select * from `users` where (`name` like 'Mr.%') and `users`.`deleted_at` is null limit 10 offset 0\nselect * from `posts` where `posts`.`user_id` in (5, 7, 63) and `published_at` is null\nTo count filtered related data, use withCount instead of with.
select\n `users`.*,\n (\n select\n count(*)\n from\n `posts`\n where\n `users`.`id` = `posts`.`user_id`\n and `published_at` is null\n ) as `posts_count`\nfrom\n `users`\nwhere\n (`name` like 'Mr.%')\n and `users`.`deleted_at` is null\nlimit\n 10 offset 0\nTo check if a relationship exists between models, you can use has.
select\n *\nfrom\n `users`\nwhere\n exists (\n select\n *\n from\n `posts`\n where\n `users`.`id` = `posts`.`user_id`\n )\n and `users`.`deleted_at` is null\nlimit\n 1\nselect * from `posts` where `posts`.`user_id` in (2) or `published_at` is null \nYou can add constraints in the has array
greaterThangreaterThanOrEqualTolessThanlessThanOrEqualTowhereselect\n *\nfrom\n `users`\nwhere\n (\n select\n count(*)\n from\n `posts`\n where\n `users`.`id` = `posts`.`user_id`\n ) > 1\n and `users`.`deleted_at` is null\nlimit\n 1\nselect\n *\nfrom\n `posts`\nwhere\n `posts`.`user_id` in (3)\n or `published_at` is null\nTo check if a relationship is absent between models, use doesntHave
select * from `users` where (`name` like 'Mr.%') and `users`.`deleted_at` is null limit 10 offset 0 \nYou can add constraints in the doesntHave array using where
select\n *\nfrom\n `users`\nwhere\n (`name` like 'Mr.%')\n and not exists (\n select\n *\n from\n `posts`\n where\n `users`.`id` = `posts`.`user_id`\n and `published_at` is null\n )\n and `users`.`deleted_at` is null\nlimit\n 10 offset 0\nYou can add multiple sort by setting the orderBy as an array and having an object with column and descending property.
select\n *\nfrom\n `users`\nwhere\n (\n select\n count(*)\n from\n `posts`\n where\n `users`.`id` = `posts`.`user_id`\n ) > 1\n and `users`.`deleted_at` is null\norder by\n `name` asc,\n `email` desc\nlimit\n 10 offset 0\nselect\n *\nfrom\n `posts`\nwhere\n `posts`.`user_id` in (14, 18, 20, 24, 31, 33, 48, 85, 97, 100)\n or `published_at` is null\nAdvance search enables the client to have more control on how to search in our API. This endpoint is accessible using a POST request only, since the client should pass a nested JSON request.
Each item in the where array will be a single closure. This means that you can group a set of properties that may use or and the other group may use and. Not unlike the Simple Search which only has a single where clause in its query.