Creación de un Servicio Web RESTFul usando PHP Parte III: Postman

febrero 13, 2019Postman, RESTFuladmin

En la tercera parte de esta serie explicare como usar Postman para probar el servicio creado. Como primer paso si no se tiene instalado es descargar la última versión de la página e instalarla.

La interfaz es sencilla, en la parte superior se encuentra un selector para el método a utilizar, a su lado la dirección a probar, por último a la izquierda el botón SEND que envía la petición.

Para probar el listado de usuarios en mi caso la URL es http://localhost/crud/users por lo que se selecciona el método GET y se enviá la petición. El resultado es el siguiente:

{"status":200,"status_message":"User List","data":{"list":[{"id":1,"name":"User1","lastname":"LastName1","email":"user1@site.com","password":12345},{"id":"User2","name":"User2","lastname":"LastName2","email":"user2@site.com","password":12345}]}}

1	{"status":200,"status_message":"User List","data":{"list":[{"id":1,"name":"User1","lastname":"LastName1","email":"user1@site.com","password":12345},{"id":"User2","name":"User2","lastname":"LastName2","email":"user2@site.com","password":12345}]}}

Como se puede ver la base de datos contiene dos usuarios, para ver el usuario con el id 1, se agrega a la URL http://localhost/crud/users/1 y el resultado es:

{"status":200,"status_message":"User by Id","data":{"user":{"id":1,"name":"User1","lastname":"LastName1","email":"user1@site.com","password":12345}}}

1	{"status":200,"status_message":"User by Id","data":{"user":{"id":1,"name":"User1","lastname":"LastName1","email":"user1@site.com","password":12345}}}

Para la creación de un usuario seleccionamos el método POST, en las pestañas inferiores se debe seleccionar Body, muy importante seleccionar la opción x-www-form-urlencoded (los parámetros se envían como un conjunto de variables unidas separadas por ampersand &).

El resultado se puede ver en la parte inferior.

Vamos a modificar el usuario creado con el método PUT cambiando el correo user3@site.com por newmail@site.com.

Para probar el método DELETE vamos a eliminar el usuario creado anteriormente usando la URL http://localhost/crud/users/3.

De esta manera se han probado los 4 métodos aceptados por el servicio web.

Creación de un Servicio Web RESTFul usando PHP Parte II

febrero 12, 2019MySQL, PHP, RESTFuladmin

En la primera parte se creo todo el código necesario para manipular los datos desde una base de datos MySQL. En el siguiente artículo se definirá el archivo userService.php el cual se encargara de manejar los 4 métodos HTTP para realizar el CRUD. En esta entrega se tratara el diseño e implementación de una API RESTFul.

El diseño de la API será el siguiente:

//GET: /users -> Obtener todos los usuarios.
//GET: /users/:id -> Obtener usuario con el id :id.
//GET: /users/rows:page -> Obtener lista paginada (columnas:pagina).
//POST: /users -> Agregar usuario, parámetros: users, name, lastname, email, password, url form unencoded
//PUT: /users/:id -> Actualizar Usuario, parámetros users, name, lastname, email, password, url form unencoded
//DELETE: /users/:id -> Eliminar Usuario con id :id

//GET: /users -> Obtener todos los usuarios.

//GET: /users/:id -> Obtener usuario con el id :id.

//GET: /users/rows:page -> Obtener lista paginada (columnas:pagina).

//POST: /users -> Agregar usuario, parámetros: users, name, lastname, email, password, url form unencoded

//PUT: /users/:id -> Actualizar Usuario, parámetros users, name, lastname, email, password, url form unencoded

//DELETE: /users/:id -> Eliminar Usuario con id :id

La primera parte a tratar sera el listado de usuarios para lo cual se usa el código:

$database = new Database();
$userDao = new UserDao($database->conn);
$method = $_SERVER['REQUEST_METHOD'];
//GET methods
if ($method=="GET"){
    if (isset($_GET['users'])){
        if ($_GET['users']==""){//List all users
            //check if is a paged query
            if (isset($_GET['limit']) && isset($_GET['page']) && !empty($_GET['limit']) && !empty($_GET['page'])){
                $result = $userDao->getUserPaginated($_GET['limit'],$_GET['page']);
                if(!empty($result))
                    response(200,"User List paginated.",$result);
                else
                    response(404,"Not found.","");
            }else{
                if (!isset($_GET['limit']) && !isset($_GET['page'])){
                    $result = $userDao->getUsers();
                    if (!empty($result))
                        response(200,"User List",$result);
                    else
                        response(404,"Not found.","");
                }else
                    response(404,"Not found.","");
            }
        }else{
            $result = $userDao->getUserById($_GET['users']);
            if (!empty($result)){
                $array=array();
                $array['user'] = $result;
                response(200,"User by Id",$array);
            }
            else
                response(404,"Not found.","");
        }
    }
}

$database = new Database();

$userDao = new UserDao($database->conn);

$method = $_SERVER['REQUEST_METHOD'];

//GET methods

if ($method=="GET"){

if (isset($_GET['users'])){

if ($_GET['users']==""){//List all users

//check if is a paged query

if (isset($_GET['limit']) && isset($_GET['page']) && !empty($_GET['limit']) && !empty($_GET['page'])){

$result = $userDao->getUserPaginated($_GET['limit'],$_GET['page']);

if(!empty($result))

response(200,"User List paginated.",$result);

else

response(404,"Not found.","");

}else{

if (!isset($_GET['limit']) && !isset($_GET['page'])){

$result = $userDao->getUsers();

if (!empty($result))

response(200,"User List",$result);

else

response(404,"Not found.","");

}else

response(404,"Not found.","");

}

}else{

$result = $userDao->getUserById($_GET['users']);

if (!empty($result)){

$array=array();

$array['user'] = $result;

response(200,"User by Id",$array);

}

else

response(404,"Not found.","");

}

En primer medida la variable $method guarda el método de petición por el cual fue accedida la Url, esto se logra mirando la variable $_SERVER[‘REQUEST_METHOD’].

Para listar los usuarios se verifica que la variable users este en la URL y dependiendo de su valor se llaman las funciones getUserById si contiene un id (para traer un usuario especifico) o getUserPaginated si están las variables limit y page en la URL, si no están se trae toda la lista de usuarios con la función getUsers.

Los códigos de respuesta usados significan:

200: Ok, Cuando se ejecuta una opción con éxito.
201: Created, Cuando se ingresa un registro.
404: Not Found, Cuando no se encuentra un recurso.

Para una lista completa de códigos se puede revisar el siguiente vínculo.

La función response se encargara de escribir las cabeceras necesarias para cumplir con la respuesta HTTP, la opción “header(‘Access-Control-Allow-Origin: *’)” habilita el acceso de diferentes orígenes y evita el error cors. La línea “header(‘Allow: GET, POST, PUT, DELETE’)” informa los métodos permitidos por el servicio.

function response($status,$status_message,$data){
    header("HTTP/1.1 ".$status." ".$status_message);
    header("Access-Control-Allow-Origin: *");
    header('Allow: GET, POST, PUT, DELETE');
    header("Content-Type:application/json");    
    $response['status']=$status;
    $response['status_message']=$status_message;
    $response['data']=$data;    
    $json_response = json_encode($response,JSON_NUMERIC_CHECK);
    echo $json_response;
}

function response($status,$status_message,$data){

header("HTTP/1.1 ".$status." ".$status_message);

header("Access-Control-Allow-Origin: *");

header('Allow: GET, POST, PUT, DELETE');

header("Content-Type:application/json");

$response['status']=$status;

$response['status_message']=$status_message;

$response['data']=$data;

$json_response = json_encode($response,JSON_NUMERIC_CHECK);

echo $json_response;

}

La respuesta del servicio se envia en formato JSON y se utiliza la constante JSON_NUMERIC_CHECK para evitar que los números se pongan dentro de comillas. Una respuesta típica del servicio tendrá la estructura:

{"status":404,"status_message":"Not found.","data":""}

1	{"status":404,"status_message":"Not found.","data":""}

Si la consulta es paginada incluirá el objeto pagination para informar el total de páginas, la página anterior, y la siguiente si existen; esto con el fin de facilitar su consumo.

{"status":200,"status_message":"User List paginated.","data":{"list":[...],"pagination":{"limit":3,"totalPages":38,"nextPage":21,"prevPage":19}}}

1	{"status":200,"status_message":"User List paginated.","data":{"list":[...],"pagination":{"limit":3,"totalPages":38,"nextPage":21,"prevPage":19}}}

El método POST se utiliza para crear un nuevo usuario.

if ($method=="POST"){
    if (isset($_POST['users']) && isset($_POST['name']) && isset($_POST['lastname']) && isset($_POST['email']) && isset($_POST['password'])){
        if (!empty($_POST['name']) && !empty($_POST['lastname']) && !empty($_POST['email']) && !empty($_POST['password'])){
            $result = $userDao->insertUser(new User(0,$_POST['name'],$_POST['lastname'],$_POST['email'],$_POST['password']));
            if ($result==1)
                response(201,"User created.",$result);
            else if ($result==-1)
                response(404,"Email taken.",$result);
            else
                response(404,"Cant create user.",$result);
        }else
            response(404,"Check data.","");
    }else
        response(404,"Not found.","");
}

if ($method=="POST"){

if (isset($_POST['users']) && isset($_POST['name']) && isset($_POST['lastname']) && isset($_POST['email']) && isset($_POST['password'])){

if (!empty($_POST['name']) && !empty($_POST['lastname']) && !empty($_POST['email']) && !empty($_POST['password'])){

$result = $userDao->insertUser(new User(0,$_POST['name'],$_POST['lastname'],$_POST['email'],$_POST['password']));

if ($result==1)

response(201,"User created.",$result);

else if ($result==-1)

response(404,"Email taken.",$result);

else

response(404,"Cant create user.",$result);

}else

response(404,"Check data.","");

}else

response(404,"Not found.","");

}

Se verifican las variables users, name, lastname, email, password, si tienen datos validos se realiza el ingreso usando la función insertUser la cual retorna 1 si fue exitoso, -1 si el correo ya esta registrado o 0 en otro caso.

Para eliminar un usuario utilizamos el método DELETE.

if ($method=="DELETE"){
    if (isset($_GET['users'])){
        if (!empty($_GET['users'])){
            $result = $userDao->deleteUserById($_GET['users']);
            if ($result)
                response(200,"User deleted.",$result);
            else
                response(404,"Cant delete user.",$result);
        }else
            response(404,"Empty argument.","");
    }else
        response(404,"Not found.","");
}

if ($method=="DELETE"){

if (isset($_GET['users'])){

if (!empty($_GET['users'])){

$result = $userDao->deleteUserById($_GET['users']);

if ($result)

response(200,"User deleted.",$result);

else

response(404,"Cant delete user.",$result);

}else

response(404,"Empty argument.","");

}else

response(404,"Not found.","");

}

Para eliminar el usuario se busca que la variable users contenga un id, la función deleteUserById retorna 1 si se elimino el registro o 0 si no se pudo (por ejemplo el usuario no existe).

Por último para modificar un usuario se utiliza el método PUT.

if ($method=='PUT'){
    $data = parse_str(file_get_contents('php://input'),$dataArray);
    if (!empty($dataArray)){
        if (!empty($dataArray['users']) && !empty($dataArray['name']) && !empty($dataArray['lastname']) && !empty($dataArray['email']) && !empty($dataArray['password'])){
            $result = $userDao->updateUser(new User($dataArray['users'],$dataArray['name'],$dataArray['lastname'],$dataArray['email'],$dataArray['password']));
            if ($result)
                response(201,"User updated.",$result);
            else
                response(404,"User not updated.",$result);
        }else
            response(404,"Missing argument.",$dataArray);
    }else
        response(404,"Missing data.",$dataArray);
}

if ($method=='PUT'){

$data = parse_str(file_get_contents('php://input'),$dataArray);

if (!empty($dataArray)){

if (!empty($dataArray['users']) && !empty($dataArray['name']) && !empty($dataArray['lastname']) && !empty($dataArray['email']) && !empty($dataArray['password'])){

$result = $userDao->updateUser(new User($dataArray['users'],$dataArray['name'],$dataArray['lastname'],$dataArray['email'],$dataArray['password']));

if ($result)

response(201,"User updated.",$result);

else

response(404,"User not updated.",$result);

}else

response(404,"Missing argument.",$dataArray);

}else

response(404,"Missing data.",$dataArray);

}

Para modificar un usuario utilizando el método PUT se debe tener en cuenta que en PHP se utiliza para recibir archivos, por lo cual se utiliza la función file_get_contents para obtener la información enviada. La función parse_str convierte una cadena de petición de estilo variable1=x&variable2=y a un arreglo para acceder más fácil a la información. La forma de acceder este arreglo será $arreglo[‘variable1’]. Si se recibieron todos los datos se procede a utilizar la función updateUser la cual retorna 1 si se actualizo el usuario o 0 en otro caso.

Con estos 4 métodos el archivo userService.php ya esta listo para manejar el CRUD de la tabla usuarios pero hasta el momento no se cumple el diseño inicial del servicio, para lograr esto en un servidor apache debemos crear un archivo .htaccess de la siguiente manera:

RewriteEngine on
RewriteRule ^users$ userService.php?users [NC,L]
RewriteRule ^users/([0-9]+)$ userService.php?users=$1 [NC,L]
RewriteRule ^users/([0-9]+):([0-9]+)$ userService.php?users&limit=$1&page=$2 [NC,L]

RewriteEngine on

RewriteRule ^users$ userService.php?users [NC,L]

RewriteRule ^users/([0-9]+)$ userService.php?users=$1 [NC,L]

RewriteRule ^users/([0-9]+):([0-9]+)$ userService.php?users&limit=$1&page=$2 [NC,L]

Esto nos permite acceder por medio de la ruta users, users/id y users/limit:page como se definió en el diseño inicial. Con esto termina el artículo de la creación de un servicio RESTFul usando PHP.

En la tercera parte explicare como probar el servicio usando Postman.

Creación de un Servicio Web RESTFul usando PHP Parte I

febrero 12, 2019MySQL, PHP, RESTFuladmin

En el presente artículo presentare la creación de un Servicio Web RESTFul usando PHP que permita la creación, eliminación, modificación y lectura de usuarios (POST,DELETE,PUT,GET) de una base de datos MySQL.

La base de datos utilizada será la siguiente:

CREATE SCHEMA IF NOT EXISTS `crud_service` DEFAULT CHARACTER SET utf8 COLLATE utf8_spanish_ci ;
USE `crud_service` ;

CREATE TABLE IF NOT EXISTS `crud_service`.`user` (
  `id` INT NOT NULL AUTO_INCREMENT,
  `name` VARCHAR(45) NOT NULL,
  `lastname` VARCHAR(45) NOT NULL,
  `email` VARCHAR(300) NOT NULL,
  `password` VARCHAR(300) NOT NULL,
  PRIMARY KEY (`id`))
ENGINE = InnoDB
DEFAULT CHARACTER SET = utf8
COLLATE = utf8_spanish_ci;

CREATE SCHEMA IF NOT EXISTS `crud_service` DEFAULT CHARACTER SET utf8 COLLATE utf8_spanish_ci ;

USE `crud_service` ;

CREATE TABLE IF NOT EXISTS `crud_service`.`user` (

`id` INT NOT NULL AUTO_INCREMENT,

`name` VARCHAR(45) NOT NULL,

`lastname` VARCHAR(45) NOT NULL,

`email` VARCHAR(300) NOT NULL,

`password` VARCHAR(300) NOT NULL,

PRIMARY KEY (`id`))

ENGINE = InnoDB

DEFAULT CHARACTER SET = utf8

COLLATE = utf8_spanish_ci;

Para acceder a la base de datos se debe ingresar los datos de la instalación local, localhost, user y password, la tabla según el esquema anterior se llama “crud_service”.

<?php
    class Database {
    
        var $servername="localhost";
        var $username="user";
        var $password="password";
        var $db="crud_service";
        
        public function __construct(){
            $this->conn = new mysqli($this->servername,$this->username,$this->password,$this->db);
            if ($this->conn->connect_error)
                die("Connection failed: "+$conn->connect_error);
        }
        
        public function getConnection(){
            return $this->conn;
        }
    }
?>

<?php

class Database {

var $servername="localhost";

var $username="user";

var $password="password";

var $db="crud_service";

public function __construct(){

$this->conn = new mysqli($this->servername,$this->username,$this->password,$this->db);

if ($this->conn->connect_error)

die("Connection failed: "+$conn->connect_error);

}

public function getConnection(){

return $this->conn;

}

Modelo de usuarios, esta clase permite manejar la información de la base de datos como objectos.

<?php
    class User {
        var $id;
        var $name;
        var $lastname;
        var $email;
        var $password;
        
        public function __construct($id,$name,$lastname,$email,$password){
            $this->id = $id;
            $this->name = $name;
            $this->lastname = $lastname;
            $this->email = $email;
            $this->password = $password;
        }
    }
?>

<?php

class User {

var $id;

var $name;

var $lastname;

var $email;

var $password;

public function __construct($id,$name,$lastname,$email,$password){

$this->id = $id;

$this->name = $name;

$this->lastname = $lastname;

$this->email = $email;

$this->password = $password;

}

Por ultimo se define un objecto UserDao para acceder a las funciones más comunes en el manejo de usuarios (creación, modificación, listado, listado paginado, eliminación).

<?php
    require "user.php";

    class UserDao{
        
        var $conn;
        
        public function __construct($conn){
            $this->conn = $conn;
            $this->conn->set_charset("utf8");
        }
        
        public function getUserByEmail($email){
            $user = null;
            if ($stmt = $this->conn->prepare("SELECT * FROM user WHERE email=?")){
                $stmt->bind_param("s",$email);
                $stmt->execute();
                $stmt->bind_result($id,$name,$lastname,$email,$password);
                if ($stmt->fetch()){
                    $user = new User($id,$name,$lastname,$email,$password);
                }
                $stmt->close();
            }
            return $user;
        }
        
        public function getUserById($id){
            $user = null;
            if ($stmt = $this->conn->prepare("SELECT * FROM user WHERE id=?")){
                $stmt->bind_param("i",$id);
                $stmt->execute();
                $stmt->bind_result($id,$name,$lastname,$email,$password);
                if ($stmt->fetch()){
                    $user = new User($id,$name,$lastname,$email,$password);
                }
                $stmt->close();
            }
            return $user;
        }
        
        public function getUsers(){
            $query = "SELECT * FROM user";
            $result = $this->conn->query($query);
            $array = array();
            $array['list']=array();
            if ($result->num_rows > 0){
                while ($row = $result->fetch_array(MYSQLI_ASSOC)){
                    $array['list'][] = new User($row['id'],$row['name'],$row['lastname'],$row['email'],$row['password']);
                }
            }
            return $array;
        }
        
        public function getUserCount(){
            $query = "SELECT * FROM user";
            return $this->conn->query($query)->num_rows;
        }
        
        public function getUserPaginated($rows,$page){
            $query = "SELECT * FROM user";
            $count = $this->getUserCount();
            $pages = ceil($count/$rows);
            $start = ($page-1)*$rows;
            $query = $query." LIMIT $start,$rows";
            $result = $this->conn->query($query);
            $array="";
            if ($page<=$pages){
                $array = array();
                $array['list']=array();
                $array['pagination']=array();
                $array['pagination']['limit']=$rows;
                $array['pagination']['totalPages']=$pages;
                if ($page+1<$pages){
                    $array['pagination']['nextPage']=$page+1;
                }
                if ($page-1>0){
                    $array['pagination']['prevPage']=$page-1;
                }
                if ($result!=null && $result->num_rows > 0){
                    while ($row = $result->fetch_array(MYSQLI_ASSOC)){
                        $array['list'][] = new User($row['id'],$row['name'],$row['lastname'],$row['email'],$row['password']);
                    }
                }
            }
            return $array;
        }
        
        public function deleteUserById($id){
            $result = 0;
            if ($stmt = $this->conn->prepare("DELETE FROM user WHERE id=?")){
                $stmt->bind_param("i",$id);
                $stmt->execute();
                $result = $stmt->affected_rows;
                $stmt->close();
            }
            return $result;
        }
        
        public function updateUser($user){
            $query = "UPDATE user SET password='".$user->password.  "', email='".$user->email."', name='".$user->name."', lastname='".$user->lastname."' WHERE id=".$user->id;
            $this->conn->query($query);
            return $this->conn->affected_rows;
            
        }
        
        public function insertUser($user){
            $aux = $this->getUserByEmail($user->email);
            if (empty($aux)){
                $query="INSERT INTO user (name,lastname,email,password) values('$user->name','$user->lastname','$user->email','$user->password')";
                $this->conn->query($query);
                return $this->conn->affected_rows;
            }else
                return -1;
        }
        
    }
?>

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

<?php

require "user.php";

class UserDao{

var $conn;

public function __construct($conn){

$this->conn = $conn;

$this->conn->set_charset("utf8");

}

public function getUserByEmail($email){

$user = null;

if ($stmt = $this->conn->prepare("SELECT * FROM user WHERE email=?")){

$stmt->bind_param("s",$email);

$stmt->execute();

$stmt->bind_result($id,$name,$lastname,$email,$password);

if ($stmt->fetch()){

$user = new User($id,$name,$lastname,$email,$password);

}

$stmt->close();

}

return $user;

}

public function getUserById($id){

$user = null;

if ($stmt = $this->conn->prepare("SELECT * FROM user WHERE id=?")){

$stmt->bind_param("i",$id);

$stmt->execute();

$stmt->bind_result($id,$name,$lastname,$email,$password);

if ($stmt->fetch()){

$user = new User($id,$name,$lastname,$email,$password);

}

$stmt->close();

}

return $user;

}

public function getUsers(){

$query = "SELECT * FROM user";

$result = $this->conn->query($query);

$array = array();

$array['list']=array();

if ($result->num_rows > 0){

while ($row = $result->fetch_array(MYSQLI_ASSOC)){

$array['list'][] = new User($row['id'],$row['name'],$row['lastname'],$row['email'],$row['password']);

}

return $array;

}

public function getUserCount(){

$query = "SELECT * FROM user";

return $this->conn->query($query)->num_rows;

}

public function getUserPaginated($rows,$page){

$query = "SELECT * FROM user";

$count = $this->getUserCount();

$pages = ceil($count/$rows);

$start = ($page-1)*$rows;

$query = $query." LIMIT $start,$rows";

$result = $this->conn->query($query);

$array="";

if ($page<=$pages){

$array = array();

$array['list']=array();

$array['pagination']=array();

$array['pagination']['limit']=$rows;

$array['pagination']['totalPages']=$pages;

if ($page+1<$pages){

$array['pagination']['nextPage']=$page+1;

}

if ($page-1>0){

$array['pagination']['prevPage']=$page-1;

}

if ($result!=null && $result->num_rows > 0){

while ($row = $result->fetch_array(MYSQLI_ASSOC)){

$array['list'][] = new User($row['id'],$row['name'],$row['lastname'],$row['email'],$row['password']);

}

return $array;

}

public function deleteUserById($id){

$result = 0;

if ($stmt = $this->conn->prepare("DELETE FROM user WHERE id=?")){

$stmt->bind_param("i",$id);

$stmt->execute();

$result = $stmt->affected_rows;

$stmt->close();

}

return $result;

}

public function updateUser($user){

$query = "UPDATE user SET password='".$user->password. "', email='".$user->email."', name='".$user->name."', lastname='".$user->lastname."' WHERE id=".$user->id;

$this->conn->query($query);

return $this->conn->affected_rows;

}

public function insertUser($user){

$aux = $this->getUserByEmail($user->email);

if (empty($aux)){

$query="INSERT INTO user (name,lastname,email,password) values('$user->name','$user->lastname','$user->email','$user->password')";

$this->conn->query($query);

return $this->conn->affected_rows;

}else

return -1;

}

En la segunda parte explicare como usar estos elementos para la creación del servicio.

Entrada Inicial

enero 5, 2019Uncategorizedadmin

#include <stdio.h>
int main(){
    printf("Hola mundo!!!");
    return 0;
}

#include <stdio.h>

int main(){

printf("Hola mundo!!!");

return 0;

}

En este blog escribiré sobre diferentes aspectos de programación de computadores, tutoriales y ejemplos de código en lenguajes como C, C++, Java, Kotlin, Node.js y Php.

AnBoCa.co Code

Blog sobre Desarrollo de Software

Creación de un Servicio Web RESTFul usando PHP Parte III: Postman

Creación de un Servicio Web RESTFul usando PHP Parte II

Creación de un Servicio Web RESTFul usando PHP Parte I

Entrada Inicial