Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imix-dkz/apirest-php
Ejemplo de CRUD simple de una API REST en PHP directo
https://github.com/imix-dkz/apirest-php
api-rest crud php
Last synced: 8 days ago
JSON representation
Ejemplo de CRUD simple de una API REST en PHP directo
- Host: GitHub
- URL: https://github.com/imix-dkz/apirest-php
- Owner: Imix-Dkz
- Created: 2024-03-06T20:28:08.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-05-12T18:15:54.000Z (9 months ago)
- Last Synced: 2024-11-16T17:06:41.670Z (2 months ago)
- Topics: api-rest, crud, php
- Language: PHP
- Homepage:
- Size: 434 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ApiRest-Php
Ejemplo simple de una API REST en PHP
Este es un ejercicio simple para la puesta en practica de una API Rest en PHP
## Que es una **API**(_Application Programming Interface_)?
Como su nombre lo indica, es una interfaz para **comunicación**, puede ser entre disitintos sistemas de software ó incluso plataformas, lo importante es el proceso de comunicación entre uno y otro.
Un Ejemplo común es el de un mesero que va por las ordenes listadas en el menú para los comensales
## Que es una **RESTful API**?
Es un tipo especifico de _API_ que sigue una serie de principios de Transferencia de Estado Representacional( **RE**presentational **S**tate **T**ransfer, REST)
Siguiendo el ejemplo del restaurante, notamos lo siguiente:
1. **Client-Server Architecture:** La arquitectura cliente-servidor que asemeja la operación de un mesero con el cliente, indica una clara separación del proceso de solicitud de ordenes, como del producto final entregado
2. **Statelessness:** _Apatridia_ o _Apátrida_(es una persona o recurso que no tiene pátria o dependencia a una nacionalidad), cada solicitud tiene que tener todo lo necesario a nivel de información para ser entregada de forma completa. Tampoco es necesario tener recuento historico de las ordenes previas.
3. **Resourse-Based:** Basado en recursos, indica que como las opciones de un menú se púeden indentificar y seccionar las _URL's_(**U**niform **R**esource **L**ocators) de forma clara para separar opciones, como platillos-principales, bebidas y postres
4. **CRUD Operations:** Una RESTful-API, normalmente soporta las 4 operaciones principales que son Crear, Leer, Actualizar y Eliminar(**C**reate, **R**ead, **U**pdate **D**elete). Esto, siguiendo el ejemplo del restaurante seria algo como, agregar nuevos platillos, revisar los existentes, actualizar precios y remover platillos
5. **Uniform Interface:** Las RESTful-API suelen contar con una Interface Uniforme estandarizada normalmente con el protocolo _HTTP_ y sus metodos GET, POST, PUT, DELETE, para realiuzar las acciones
6. **Representation:** Hace referencia a la representación de datos, usualmente en un formato que el cliente pueda manejar, como XML o JSON
### [NOTA 1] : Se añade un ejemplo de control de pruebas de PHP_Unit
7. [**PHP Unit:**](#php-unit) En su directorio personal, se añade control de pruebas de un ejercicio
El origen de este ejercicio parte del vídeo _"Como crear una API Rest en PHP paso a paso"_, del canal: **Garaje de Ideas**
* Enlace al [**vídeo** watch?v=QJfRtxxJ1TA](https://www.youtube.com/watch?v=QJfRtxxJ1TA)
* En este ejemplo se usa RapidAPI para realizar pruebas, pero debido a que tiene un periodo de prueba se usará POSTman
## [Nota 2]
* La principal diferencia con el curso del video, es que la forma de llamar las variables de conexión, aw hace por segurida con un archivo arreglo que está oculto, pero solo hay que mandar a hacer un archivo "env.php" dentro de include con la siguiente estructura...
````
$dbConf['DB_CONN'] = "mysql";
$dbConf['DB_HOSTp'] = "LOCALHOST:XXXX"; //ip:puerto
$dbConf['DB_DATABASE'] = "DB_name";
$dbConf['DB_USERNAME'] = "Usr_Name";
$dbConf['DB_PASSWORD'] = "Psw";
````
### PHP Unit
Basado en el ejercico del video [Unit Testing with PHP Unit
](https://www.youtube.com/watch?v=a5ZKCFINUkU), del canal [srenspangsbergjrgensen2419](https://www.youtube.com/@srenspangsbergjrgensen2419).
La forma correcta de instalar la libreria de pruebas es la siguiente:
````
$ composer require phpunit/phpunit ^9 --dev
````
Durante el armado de pruebas, es importante, configurar correctamente el archivo "composer.json" agregando el siguiente extracto
````
{
...
},
/* //Apartir de aqui */
"autoload": {
"psr-4": {
"App\\": "app"
}
}
````
Despues, hay que ejecutar( para asegurarser que están bien los datos):
````
composer update
````