Api json example php

Saved searches

Use saved searches to filter your results more quickly

You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.

Implementation of JSON API in PHP

License

json-api-php/json-api

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Sign In Required

Please sign in to use Codespaces.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching Xcode

If nothing happens, download Xcode and try again.

Launching Visual Studio Code

Your codespace will open once ready.

There was a problem preparing your codespace, please try again.

Latest commit

Git stats

Files

Failed to load latest commit information.

README.md

JSON API spec implemented in PHP 7. Immutable

The goal of this library is to ensure strict validity of JSON API documents being produced.

< "data": < "type": "articles", "id": "1", "attributes": < "title": "Rails is Omakase" >, "relationships": < "author": < "data": < "type": "people", "id": "9" >, "links": < "self": "/articles/1/relationships/author", "related": "/articles/1/author" > > > > >

 use JsonApiPhp\JsonApi\Attribute; use JsonApiPhp\JsonApi\DataDocument; use JsonApiPhp\JsonApi\Link\RelatedLink; use JsonApiPhp\JsonApi\Link\SelfLink; use JsonApiPhp\JsonApi\ResourceIdentifier; use JsonApiPhp\JsonApi\ResourceObject; use JsonApiPhp\JsonApi\ToOne; echo json_encode( new DataDocument( new ResourceObject( 'articles', '1', new Attribute('title', 'Rails is Omakase'), new ToOne( 'author', new ResourceIdentifier('author', '9'), new SelfLink('/articles/1/relationships/author'), new RelatedLink('/articles/1/author') ) ) ), JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES );

composer require json-api-php/json-api

First, take a look at the examples. All of them are runnable.

The library API and use-cases are expressed in a comprehensive suite of tests.

• Data Documents (containing primary data)
  • with a single Resource Object
  • with a single Resource Identifier
  • with null data
  • with multiple Resource Objects
  • with multiple Resource Identifiers
  • with a new Resource (no id)

  About

  Implementation of JSON API in PHP

  Источник

  Create a JSON REST API with PHP and MySQL On Ubuntu 20.04

  An application programming interface (API) is a middleware that allows two applications to talk to each other through a representational state transfer (REST) channel. For instance, if you’re developing a mobile application that uses a cloud database, you may create a PHP API to interface the Android client to a remote MySQL database. Another use-case of an API is to open your popular application to the end-users. Companies including Vultr, Google, Facebook, and Twitter have a public API. In this case, consumers accessing your application will use dedicated URL endpoints to submit and query data without going through your application’s graphical user interface (GUI).

  Creating an API for your application allows end-users to integrate your services flexibly, leading to a better user experience. Also, when your API endpoints return data in JavaScript object notation (JSON) format, it can be used by mobile, desktop applications, tablets, and embedded devices without changing the code in the backend. In this guide, you’ll create an open JSON REST API for your hypothetical online store with PHP on Ubuntu 20.04. When you complete this guide, you should call your API endpoints to retrieve products from your database without going through a GUI.

  Prerequisites

  Before you begin following along with this tutorial, ensure you have the following:

  • An Ubuntu 20.04 server.
  • A sudo user.
  • A LAMP Stack. This guide works fine with either the MySQL or the MariaDB server.

  Create a Sample Database

  SSH to your server and run the command below to log in to the MySQL command-line interface (CLI).

  Enter the root password of your MySQL server and press ENTER to proceed. After you get the mysql> prompt, issue the command below to create a store_api database.

  mysql> CREATE DATABASE store_api; 

  Next, create a non-root MySQL user. You will use this user’s credentials to connect to the MySQL database in your PHP code.

  mysql> CREATE USER 'api_user'@'localhost' IDENTIFIED WITH mysql_native_password BY 'EXAMPLE_PASSWORD'; mysql> GRANT ALL PRIVILEGES ON store_api.* TO 'api_user'@'localhost'; mysql> FLUSH PRIVILEGES; 

  If you’re using MariaDB instead of MySQL, use this command instead to create the user.

  MariaDB> GRANT ALL PRIVILEGES on store_api.* TO 'api_user'@'localhost' identified by 'EXAMPLE_PASSWORD'; 

  Switch to the newly created database.

  Next, you’ll create a products table. This table lists the currently available items for purchase in your hypothetical store, including their prices. Without an API, end-users accessing your web applications must go through a User Interface such as a web application or desktop software to get the product list. However, later in this tutorial, you’ll learn how to expose this table information through a PHP API.

  Create the products table.

  mysql> CREATE TABLE products ( product_id BIGINT NOT NULL AUTO_INCREMENT PRIMARY KEY, product_name VARCHAR(50), cost_price DOUBLE, retail_price DOUBLE ) ENGINE = InnoDB; 

  Populate the products table with some records.

  mysql> INSERT INTO products (product_name, cost_price, retail_price) VALUES ('LEATHER JACKET', '89.23', '99.95'); mysql> INSERT INTO products (product_name, cost_price, retail_price) VALUES ('SILVER COAT', '44.00', '60.00'); mysql> INSERT INTO products (product_name, cost_price, retail_price) VALUES ('REXI BELT', '14.49', '18.85'); mysql> INSERT INTO products (product_name, cost_price, retail_price) VALUES ('SUEDE SHOE', '24.00', '36.00'); mysql> INSERT INTO products (product_name, cost_price, retail_price) VALUES ('WOOLEN SWEATER', '14.45', '18.00'); 

  Ensure the records are in place by running a SELECT query against the products table.

  mysql> SELECT product_id, product_name, cost_price, retail_price FROM products; 

  MySQL should display the following list.

  +------------+----------------+------------+--------------+ | product_id | product_name | cost_price | retail_price | +------------+----------------+------------+--------------+ | 1 | LEATHER JACKET | 89.23 | 99.95 | | 2 | SILVER COAT | 44 | 60 | | 3 | REXI BELT | 14.49 | 18.85 | | 4 | SUEDE SHOE | 24 | 36 | | 5 | WOOLEN SWEATER | 14.45 | 18 | +------------+----------------+------------+--------------+ 5 rows in set (0.00 sec) 

  Exit from the MySQL command-line interface.

  Configure Apache ModRewrite

  Your API endpoints will rely heavily on Apache’s re-write rules. You need to make some configuration changes to the Apache server to make this possible. First, enable the rewrite module.

  Then, open the /etc/apache2/apache2.conf configuration file using nano for editing.

  $ sudo nano /etc/apache2/apache2.conf 

  Locate the . directive as shown below.

  . Options Indexes FollowSymLinks AllowOverride None Require all granted . 

  Then, change the line AllowOverride None to AllowOverride All .

  . Options Indexes FollowSymLinks AllowOverride All Require all granted . 

  The AllowOverride All directive allows .htaccess files to override the base Apache configurations. Restart Apache to reload the changes.

  $ sudo systemctl restart apache2 

  Create a .htaccess File

  First, create a working directory. In a real-world application, your API can have several endpoints. Therefore, it is a good idea to create a project directory to place all your PHP classes and other configuration files. In this case, you’re using v1 (version 1) as the base directory’s name.

  When your API grows, and you need to version it, you can create other directories with the version number at the end of the file name(e.g. v2 , v3 , v4 ).

  $ sudo mkdir -p /var/www/html/api/v1 

  Create a new .htaccess File in the /var/www/html/api/v1 directory.

  $ sudo nano /var/www/html/api/v1/.htaccess 

  Enter the information below into the file.

  RewriteEngine On RewriteBase /api/v1 RewriteCond % !-f RewriteCond % !-d RewriteRule (.*)$ index.php?request=$1 [QSA,NC,L] 

  The .htaccess file code explanation:

  The first line, as shown below in the .htaccess files, enables Apache mod_rewrite module.

  . RewriteCond % !-f RewriteCond % !-d . 

  . RewriteRule (.*)$ index.php?request=$1 [QSA,NC,L] . 

  Create a Base index.php File

  Next create an index.php file in your /var/www/html/api/v1/ folder. This file will act as a router for all requests coming into your API.

  $ sudo nano /var/www/html/api/v1/index.php 

  Then, enter the information below into the file.

   spl_autoload_register('load_class'); $http_verb = $_SERVER['REQUEST_METHOD']; if ($_SERVER['REQUEST_METHOD'] == 'GET') < foreach($_GET as $key =>$value) < $params[$key] = $value; >> $request = explode('/', $_REQUEST['request']); $resource = $request[0]; if (isset($request[1])) < $resource_id = $request[1]; >else < $resource_id = ''; >if ($resource == 'products') < $request = new Products; >if ($http_verb == 'GET') < if (!empty($resource_id)) < $response = $request->read($resource_id); > else < $response = $request->read($resource_id, $params); > echo $response; > 

  Save and close the file when you’re through with editing.

  The .index file code explanation:

  The first line is a PHP header that tells web clients to treat the data in JSON format.

  . header("Content-type:application/json"); . 

  . function load_class($class) < require_once $class . '.php'; >spl_autoload_register('load_class'); . 

  . $http_verb = $_SERVER['REQUEST_METHOD']; if ($_SERVER['REQUEST_METHOD'] == 'GET') < foreach($_GET as $key =>$value) < $params[$key] = $value; >> . 

  . $request = explode('/', $_REQUEST['request']); $resource = $request[0]; if (isset($request[1])) < $resource_id = $request[1]; >else < $resource_id = ''; >if ($resource == 'products') < $request = new Products; >. 

  . if ($http_verb == 'GET') < if (!empty($resource_id)) < $response = $request->read($resource_id); > else < $response = $request->read($resource_id, $params); > echo $response; > . 

  Create a products.php Class File

  When you make calls to the products resource(e.g. http://localhost/api/v1/products or http://localhost/api/v1/products/1 ) you’ll be routed to a class file named Products . So, create the file.

  $ sudo nano /var/www/html/api/v1/Products.php 

  Enter the information below into the file.

  setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); $pdo->setAttribute(PDO::ATTR_EMULATE_PREPARES, false); $data = []; $sql = "select * from products "; if (!empty($resource_id)) < $sql .= " where product_id = :product_id"; $data['product_id'] = $resource_id; >else < $filter = ''; if (isset($params['product_name']) ) < $filter .=" and product_name = :product_name"; $data['product_name'] = $params['product_name']; >$sql .= " where product_id > 0 $filter"; > $stmt = $pdo->prepare($sql); $stmt->execute($data); $products = []; while ($row = $stmt->fetch(PDO::FETCH_ASSOC)) < $products[] = $row; >$response = []; $response['data'] = $products; if (!empty($resource_id)) < $response['data'] = array_shift($response['data']); >return json_encode($response, JSON_PRETTY_PRINT); > catch (PDOException $ex) < $error = []; $error['message'] = $ex->getMessage(); return $error; > > > 

  Save and close the file when you’re through with editing.

  The /var/www/html/api/v1/Products.php Explanation:

  First, you’re creating a new Products class that you call in the index.php file wherever there is a new products resource request.

  . $db_name = 'store_api'; $db_user = 'api_user'; $db_password = 'EXAMPLE_PASSWORD'; $db_host = 'localhost'; $pdo = new PDO('mysql:host=' . $db_host . '; dbname=' . $db_name, $db_user, $db_password); $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); $pdo->setAttribute(PDO::ATTR_EMULATE_PREPARES, false); . 

  . $data = []; $sql = "select * from products "; if (!empty($resource_id)) < $sql .= " where product_id = :product_id"; $data['product_id'] = $resource_id; >else < $filter = ''; if (isset($params['product_name']) ) < $filter .=" and product_name = :product_name"; $data['product_name'] = $params['product_name']; >$sql .= " where product_id > 0 $filter"; > . 

  . $stmt = $pdo->prepare($sql); $stmt->execute($data); $products = []; while ($row = $stmt->fetch(PDO::FETCH_ASSOC)) < $products[] = $row; >$response = []; $response['data'] = $products; if (!empty($resource_id)) < $response['data'] = array_shift($response['data']); >return json_encode($response, JSON_PRETTY_PRINT); > catch (PDOException $ex) < $error = []; $error['message'] = $ex->getMessage(); return $error; . 

  Test the API

  The final step is testing the codes that you’ve developed. Use the Linux curl command to execute the API endpoint below.

  $ curl localhost/api/v1/products 

  You should get an output displaying all products in JSON format.

  To retrieve a single product, specify a resource id at the end of the URL as shown below.

  $ curl localhost/api/v1/products/1 

  $ curl localhost/api/v1/products/2 

  $ curl localhost/api/v1/products?product_name=SUEDE%20SHOE 

  As you can confirm from the JSON responses above, your PHP API is working as expected.

  Conclusion

  You’ve implemented a PHP API that outputs data in JSON format with MySQL and Ubuntu 20.04 server in this guide. You may tweak the code in this tutorial to suit your needs. Remember, you may extend your API to accept other HTTP verbs/methods like POST , PUT and DELETE .

  Want to contribute?

  You could earn up to $600 by adding new articles.

  Источник

  Читайте также:  Buy and sell php scripts