Cómo construir una API REST con Laravel Orion

January 05, 2022

Tags: Tecnologías
laravel
Unsplash

 

Una Interfaz de Programación de Aplicaciones, o API por sus siglas en inglés, es uno de los conceptos más complicados que hay en el mundo de la programación, pero también el que más útil ha sido en los últimos años, ya que son una serie de protocolos que posibilitan el diseño e integración de software y aplicaciones.

 

La página oficial de Mulesoft, define a una API como "API es el acrónimo de Application Programming Interface, que es un intermediario de software que permite que dos aplicaciones se comuniquen entre sí. Cada vez que usa una aplicación como Facebook, envía un mensaje instantáneo o verifica el clima en su teléfono, está usando una API".

 

CodeAcademy define REST como "REST, o Transferencia de Estado Rpresentacional, es un estilo arquitectónico para proporcionar estándares entre sistemas informáticos en la web, lo que facilita la comunicación entre los sistemas. Los sistemas compatibles con REST, a menudo llamados sistemas RESTful, se caracterizan por la forma en que no tienen estado y separan las preocupaciones del cliente y del servidor.

 

Ahora veamos cómo construir una API REST con la ayuda de Laravel Orion

 

Laravel Orion te permite crear APIs REST en cuestión de minutos, trabajando con modelos suaves eliminables y realizando una búsqueda exhaustiva.

 

Recursos del modelo

 

Asumamos que tienes un modelo 'Post' que representa una publicación de blog y esta quieres manejarla vía una API Rest. Con Laravel Orion, esto puede conseguirse en tres simples pasos.

 

Primero, vamos a crear el 'PostController' y extenderlo desde 'OrionHttpControllersController'

 

<?php
 
namespace App\Http\Controllers\Api;
 
use App\Models\Post;
use Orion\Http\Controllers\Controller;
 
class PostsController extends Controller
{
 
}

 

Luego, define la propiedad '$model' y establécela en el nombre de clase de modelo completamente calificado. El controlador completo debería verse así:

 

<?php
 
namespace App\Http\Controllers\Api;
 
use Orion\Http\Controllers\Controller;
 
class PostsController extends Controller
{
    /**
     * Fully-qualified model class name
     */
    protected $model = Post::class; // or "AppModelsPost"
}

 

Para finalizar, registra las rutas en 'api.php' y llamas 'Orion::resource'

 

<?php
 
use Illuminate\Support\Facades\Route;
use Orion\Facades\Orion;
use App\Http\Controllers\PostsController;
 
Route::group(['as' => 'api.'], function() {
    Orion::resource('posts', PostsController::class);
});

 

Listo :tada: ahora puedes crear, enumerar, buscar, ver, actualizar y eliminar publicaciones de blog a través de la API REST. Intente crear una publicación a través de ((POST) https://<your app url>/api/posts endpoint :wink:

 

También puede ver todos los puntos finales disponibles ejecutando el comando php artisan route:list.

 

Así podemos crear una API REST con Laravel Orion y que funciona para múltiples propósitos, como el que vimos en este ejemplo de manejar la publicación de un blog. Si quieres ser uno de los desarrolladores que cree tecnologías de vanguardia como esta, solo haz click aquí y podrás formar parte de un equipo multicultural en Rootstack

 

Te recomendamos en video

 

Yes, I liked thiscontent.