API en PHP para recibir peticiones HTTP (GET,POST,PUT,DELETE) desde cualquier aplicación. A modo de ejemplo solo se incluye un objeto en la base de datos.
-
GET Devuelve los datos en JSON.
-
POST,PUT,DELETE devuelven el identificador del objeto insertado, modificado o eliminado.
-
Permite subir imagenes, se almacenan en el servidor y se devuelven como texto base 64.
-
Uso de controladores y DAO, para separar el control del acceso a los datos.
-
Uso de PDO (PHP) para usar consultas parametrizadas y aumentar la seguridad de la la base de datos a la que accede la RestApi.
-
Permite peticiones GET y POST con el método sobrecargado, debido a que la mayoria de hosting gratuitos sólo permiten peticiones GET y POST.
-
Uso una implementación de JWT (JSON Web Token) para generar un token cuando el usuario inicia sesión, este token será enviado al usuario y lo reenviará en cada petición, de esta forma podemos saber que usuario ha realizado cada petición. En la página jwt.io podemos encontrar varias implementaciones para diferentes lenguajes, he usado la implementación PHP creada por Brent Shaffer (https://github.com/bshaffer), en concreto: https://github.com/firebase/php-jwt
-
Para editar un objeto uso la petición PUT, pero para subir imagenes al servidor hay que hacerlo con POST, por lo tanto para editar imagenes realizo una petición POST con el campo "imagenesPUT" para saber que en realidad estoy editando.
Instrucciones para obtener una copia del proyecto en funcionamento en tu máquina local. Mira Deployment para conocer como desplegar el proyecto.
Un servidor web local como XAMPP o instalar por tu cuenta: Apache 2.4.41, MariaDB 10.4.6, PHP 7.1.32, phpMyAdmin 4.9.0.1, OpenSSL 1.0.2. (https://www.apachefriends.org/es/download.html)
Puedes realizar peticiones Get escribiendo directamente en la ruta del navegador, o instalar una extensión para Chrome como POSTMAN (https://www.getpostman.com/) para realizar peticiones HTTP. Obviamente, también puedes realizar las peticiones directamente desde la aplicación/es que usarán ésta RestApi. Por ejemplo, desde una aplicación web puedes usar peticiones ajax usando JQuery, o desde una aplicación móvil Android puedes usar la librería Loopj.
La implementación de JWT (https://github.com/firebase/php-jwt).
Una vez descargado el proyecto: -Arranca los servicios de Apache y MySQL/MariaDB desde el panel de Control de Xampp.
- Crea la base de datos, ejecutando el script "backup.sql" en phpmyadmin. Como verás hemos creado un usuario con una clave ya codificada, para poder usar la RestApi y crear nuevos usuarios y/u otros objetos. El usuario creado es admin y su clave es admin. Esto lo hago así, ya que la RestAPi solo recibe peticiones de un usuario que se haya identificado previamente (para protegerla de peticiones externas), por lo que no se pueden crear usuarios (realizando peticiones http) sin antes habernos identificado.
-Edita el archivo Database/database.php Escribe tu servidor, base de datos, usuario y contraseña. $this->pdo = new PDO('mysql:host=SERVIDOR;dbname=NOMBRE_BASE_DATOS;charset=utf8', 'USUARIO_BASE_DATOS', 'CONTRASEÑA');
-Edita el archivo inc/token.php, en la línea: define('SERVER', "RUTA_SERVIDOR"); escribir la ruta del servidor (http://localhost 0 https://webhosting.subdominio.com)
- Descargar el proyecto php-jwt y copialo en tu htdocs/public_html.
Para realizar una petición sencilla y obtener el resultado, podemos escrbir en el navegador localhost/restapi/v1/profesor/admin y veremos el resultado: {"error":"401","mensaje":"El token no es válido, vuelve a iniciar sesión."}
Iniciar Sesión usando POSTMAN
Realizar una petición con el token recibido
Para desplegar este proyecto, podemos subirlo a un hosting y usarlo desde ahí en lugar de en local. Debemos crear la base de datos en el hosting y, al igual que en local, cambiar en el archivo database.php los datos del servidor, nombre de la base de datos, usuario y clave. Normalmente, el hoting nos crea un usuario ftp para subir los archivos al servidor. Una vez subido podemos usar de nuevo POTMAN. Hay que recordar que muchos hosting solo permiten peticiones GET y POST, pero podemos sobrecargar estos métodos.
- PHP usando PDO y DAO
- SQL
- José Rubén Castro Soriano - Trabajo Inicial - RubensSoft
También puedes mirar la lista de todos los contribuyentes quíenes han participado en este proyecto.
Este proyecto está bajo la Licencia GNU (General Public License) - mira el archivo LICENSE.md para detalles.
- Gracias a Brent Shaffer (https://github.com/bshaffer) por su implementación JWT en PHP (https://github.com/firebase/php-jwt).