Creando una API básica en Ruby on Rails Parte 2

Juan Carlos Santiago
3 min readMay 21, 2021

--

Ahora que tenemos todo listo, comencemos a programar, manos a la obra.

Creando estructura de carpetas

Para esta api, manejaremos la siguiente estructura de carpetas:
controllers →api →v1, teniendo una salida con la siguiente estructura.
http://localhost:3000/api/v1/pets.

estructura de carpetas

Creando nuestro modelo

Creemos nuestro modelo llamado Pet, ejecutando el siguiente comando.

rails g model pet name:string age:string category:string

Posterior a esto, ejecutamos su respectivo rake db:migrate para que agregue nuestro modelo a la base de datos.

Perfecto!, ahora creamos dentro de controllers →api →v1 un archivo que llamaremos pets_controller.rb

Espera…regresaremos a este archivo más tarde.

Configurando nuestras rutas

En nuestro archivo config/routes.rb, debemos agregar los namespaces correspondientes a nuestra api, al finalizar, nuestro archivo deberá tener la siguiente estructura.

Vaya!, ya esta agarrando forma nuestra pequeña api, es hora de agregar nuestra lógica para la inserción de las mascotas.

regresamos a nuestro archivo pets_controller.rb

Agregando Mascotas

Ahora en nuestro archivo pets_controller.rb, agregaremos la lógica para agregar nuestras mascotas quedando el archivo de la siguiente manera.

Probemos nuestro método, para ello usaremos el Postman, en el cual haremos una petición POST para agregar nuestra mascota.

Debemos configurar nuestro header, para que acepte nuestro JSON, quedando de la siguiente manera.

mandemos la petición… si todo ha salido de maravilla hasta aquí, tendremos el siguiente resultado.

Genial!, ya tenemos nuestra api aceptando nuestros datos JSON, ahora como obtengo los datos de la mascota que acabo de crear?, pasemos a ello.

Obteniendo Mascotas

Para obtener nuestras mascotas, podemos usar el mismo endpoint en este caso http://localhost:3000/api/v1/pets o podríamos volver a realizar la tarea de crear archivos, configurar otra ruta etc.… en este caso voy a usar el mismo endpoint.

Ahora el archivo pet_controller.rb tendrá el siguiente aspecto!

Probemos nuevamente nuestro endpoint, solo que ahora en lugar de hacer un POST, haremos un GET.

Genial!, este es el resultado de la petición que hemos echo.

Nuestra pequeña API funciona!, después de esto, tu eres el encargado de poner en practica los siguientes métodos de nuestra api.

Espero y este pequeño ejemplo te haya servido y pongas en practica el conocimiento y comenta si tienes alguna duda al respecto!

Gracias por la lectura!

--

--

Juan Carlos Santiago
Juan Carlos Santiago

Responses (1)