RESTful APIs using Laravel

Introduction

Pre Workshop Webinar:

Introduction to Advanced Web Development

Slides

https://slides.com/saadbinamjad/intro-to-advanced-web-development

Video

https://www.facebook.com/watch/?v=34735400019038

Workshop Structure

Session 1

Workshop Introduction
RESTful API Concepts
RESTful API Design

Session 2

Laravel Essentials
Bootstrapping with Laravel

Session 3

Building RESTful APIs
Open API Specification
Coding Tasks.

Session 4

Code Review
Solution Discussion.

Playground

Whimsical

https://whimsical.com/restful-api-design-CjrjT2QFVfnrVfJxSCCSbW

Local Playground:

https://github.com/typicode/json-server
Postman or Insomnia

Reading Materials

API

HTTP

REST

REST API Design

Why no HATEOAS

Hypermedia as the engine of application state (https://www.youtube.com/watch?v=6UXc71O7htc)

Best Practices:

Laravel Learning Paths

https://github.com/LaravelDaily/Laravel-Roadmap-Learning-Path

Tasks

We want to create an online book store that allows users to browse through different genres of books and then if they want to purchase it, they need to sign in the system and order for their copy. The Admin, the store owner, can see the orders and then decide to ship them according to the user addresses.

Pre-requisites

Git

Github Account

With Docker

Docker: https://docs.docker.com/get-docker/

Code Editor: like VSCode or get the free trail version of PHPStorm,

Without Docker

If no docker, then you have to install Composer, PHP (Preferred PHP 8, PHP 7.4 would also do), MySQL, Git, Redis.

Open API Specification: https://swagger.io/tools/swagger-editor/

PHP

Create a file named: index.php.
Drop this code snippet:

<!DOCTYPE html>
<html>
<body>
<h1>Saad</h1>
<?php
echo "Hello World!<br>";
?>
</body>
</html>

Requires a web server to run its code.
Comes with a built in server, when you install PHP.
And then run the following command:

php -S localhost:3000 index.php

In order to create web applications, and to have the best practises for reusuable scalable and maintainable PHP code, we resort to PHP frameworks.

Laravel

Benefits of Framework:

Out-of-the-box application architecture.
Faster development.
Highly testable.
Scalable
Loosely coupled
Easily maintainable applications.

Principles

- Model View Controller
- Laravel Codebase
- Laravel Essentials
- Bootstrapping with Laravel Breeze and JetStream

Examples

Laravel 8 Demo: https://github.com/Saad-Amjad/laravel8-demo
Laravel Breeze: https://github.com/Saad-Amjad/laravel-breeze-demo
Laravel Jetstream: https://github.com/Saad-Amjad/laravel-jetstream-demo

Task

We want to create an online book store that allows users to browse through different genres of books and then if they want to purchase it, they need to sign in the system and order for their copy. The Admin, the store owner, can see the orders and then decide to ship them according to the user addresses.

Sample GET Books API Task

{
    "books": [
        {
            "title": "demo 1",
            "author": "saad1",
            "id": 1,
            "book_url": "api/v1/books/1",
            "author_url": "api/v1/authors/saad1"
        },
        {
            "title": "demo 2",
            "author": "saad2",
            "id": 2,
            "book_url": "api/v1/books/2",
            "author_url": "api/v1/authors/saad2"
        }
    ]
}

With Pagination and Meta

{
  "data": [
    {
      "id": 1,
      "title": "Compatible exuding software as",
      "book_url": "api\/v1\/books\/1",
      "author": "Bethany Funk III",
      "author_url": "api\/v1\/authors\/1"
    },
    {
      "id": 2,
      "title": "Open-source asynchronous encoding",
      "book_url": "api\/v1\/books\/2",
      "author": "Bethany Funk III",
      "author_url": "api\/v1\/authors\/1"
    },
    {
      "id": 3,
      "title": "Configurable regional budgetarymanagement",
      "book_url": "api\/v1\/books\/3",
      "author": "Verona Lubowitz",
      "author_url": "api\/v1\/authors\/2"
    },
    {
      "id": 4,
      "title": "Ergonomic actuating support",
      "book_url": "api\/v1\/books\/4",
      "author": "Verona Lubowitz",
      "author_url": "api\/v1\/authors\/2"
    },
    {
      "id": 5,
      "title": "Business-focused bifurcated help-desk",
      "book_url": "api\/v1\/books\/5",
      "author": "Gerda Dare I",
      "author_url": "api\/v1\/authors\/3"
    }
  ],
  "links": {
    "first": "http:\/\/localhost:8000\/api\/v1\/books?page=1",
    "last": "http:\/\/localhost:8000\/api\/v1\/books?page=2",
    "prev": null,
    "next": "http:\/\/localhost:8000\/api\/v1\/books?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 2,
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "http:\/\/localhost:8000\/api\/v1\/books?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": "http:\/\/localhost:8000\/api\/v1\/books?page=2",
        "label": "2",
        "active": false
      },
      {
        "url": "http:\/\/localhost:8000\/api\/v1\/books?page=2",
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "path": "http:\/\/localhost:8000\/api\/v1\/books",
    "per_page": 5,
    "to": 5,
    "total": 10
  }
}

Name		Name	Last commit message	Last commit date
Latest commit History 20 Commits
app		app
bootstrap		bootstrap
config		config
database		database
public		public
resources		resources
routes		routes
storage		storage
tests		tests
.editorconfig		.editorconfig
.env.example		.env.example
.gitattributes		.gitattributes
.gitignore		.gitignore
.styleci.yml		.styleci.yml
README.md		README.md
artisan		artisan
composer.json		composer.json
composer.lock		composer.lock
package.json		package.json
phpunit.xml		phpunit.xml
server.php		server.php
webpack.mix.js		webpack.mix.js

Saad-Amjad/laravel-restful-apis

Folders and files

Latest commit

History

Repository files navigation

RESTful APIs using Laravel

PHP

Laravel

Task

Todos / Steps

About

Resources

Stars

Watchers

Forks

Languages