Que es Laravel API
Bueno desde hace mucho he venido trabajando APIs en Laravel y he aprendido muchas cosas. Entre ellas es que no siempre es divertido hacer tanto trabajo repetitivo. Inicialmente cree un Starter Kit que es algo así como un punto de partida para un API en Laravel 5.1. Pero el framework ha avanzado bastante rápido así que tuve que actualizar a 5.4 y acá les voy a mostrar como usar Laravel API.
Instalación
Lo primero que debemos hacer es instalar el starter kit con composer de la siguiente forma
1 | composer create-project joselfonseca/laravel-api new-api |
Esto va a descargar la version 2.0 que es la que está hecha con Laravel 5.4, probablemente te de un error cuando termine de instalar las dependencias de composer, si es así no te preocupes que es normal.
Una ves composer termine de instalar las dependencias vamos a correr una serie de comandos para instalar el API. Ingresando a la carpeta del proyecto correremos:
1 2 | touch storage/oauth-private.key touch storage/oauth-public.key |
Modificamos el archivo .env con los datos de nuestra base de datos. (Ten en cuenta que debes crear la base de datos antes de hacer esto.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | APP_ENV=local APP_DEBUG=true APP_KEY=base64:hvPj/q0eoLxpS2xcm4lkRKJoOhGmiNgbfARYY1UPRH8= DB_HOST=localhost DB_DATABASE=new_api DB_USERNAME=root DB_PASSWORD=secret CACHE_DRIVER=file SESSION_DRIVER=file QUEUE_DRIVER=sync MAIL_DRIVER=smtp MAIL_HOST=mailtrap.io MAIL_PORT=2525 MAIL_USERNAME=null MAIL_PASSWORD=null MAIL_ENCRYPTION=null |
Ahora corremos las migraciones.
1 | php artisan migrate |
Necesitamos instalar Laravel Passport
1 | php artisan passport:install |
Esto generará las llaves de encriptación y los clientes principales como se ve a continuación.
Ahora vamos a instalar el API como tal usando el siguiente comando
1 | php artisan app:install |
Este comando nos va a pedir que creemos un usuario administrador, esto es para poder ingresar a un pequeño portal de desarrollo que está en el kit. Desde este portal se podrán crear los clientes del API y ver la documentación del mismo.
Ahora debemos correr el instalador de dependencias de node ya sea NPM o Yarn, personalmente prefiero Yarn
1 | yarn install |
Por último vamos a compilar los CSS y JS del proyecto, para esto estamos usando Laravel Mix
1 | npm run dev |
Lista la instalación!
Características del Kit
Ahora que ya tienes instalado el API Starter Kit esto es lo que obtienes:
A demás de esto, si ingresas al navegador después de publicar el proyecto en un servidor web verás una pantalla de login donde puedes ingresar las credenciales que colocamos en la instalación.
Al ingresar verás un menu con algunas opciones.
En API Documentation verás la documentación del API en API Blueprint compilado por Aglio
Y lo mejor de todo, tienes una suite de pruebas que te permite iniciar los features de tu API con el endpoint de users implementado y probado.
Esto ha sido una breve introducción a Laravel API starter kit. Espero les sea útil y recuerden que siempre se puede mejorar haciendo un Pull Request en el repositorio que puedes visitar en
https://github.com/joselfonseca/laravel-api
Feliz programación!