Implementación de un Health Check Endpoint en API con RSpec

Curso de Creación de APIs con Ruby on Rails

Contenido del curso

Introducción

Proyecto

Cierre

33
Creación de APIs con Rails: Buenas Prácticas y Features Avanzados
00:43 min

Tomar examen

Cursos Empresas Blog Live Conf Eventos Precios

0:0012:28

Implementación de un Health Check Endpoint en API con RSpec

Curso de Creación de APIs con Ruby on Rails

Clase 6 de 33

Clase 6 / 33

Recursos

Implementa un health check endpoint en Rails con RSpec y TDD para asegurar servicios confiables y monitoreables. Aprenderás a validar el estado de tu API con pruebas de integración, a responder en JSON con status code 200 y a configurar rutas y controladores de forma clara y mantenible.

¿Qué es un health check endpoint y para qué sirve?

Un health check es un endpoint convencional como /health o /health_check que responde con 200 cuando el servicio está operativo. Es una buena práctica porque permite el monitoreo continuo por herramientas como Pingdom o Runscope mediante un request periódico. Además, se relaciona con páginas de estado públicas como las de Heroku, GitHub o Twitter, usadas para verificar si una aplicación está en buen estado.

Verificar disponibilidad del servicio con un request simple.
Integración con Pingdom y Runscope a través de /health.
Responder con 200 cuando todo está ok.
Alertar al equipo si hay error o no hay respuesta.

¿Cómo escribir pruebas de integración con RSpec para el health endpoint?

La estrategia es TDD: primero se escriben las pruebas, luego la funcionalidad. Crea el directorio spec/requests para pruebas de integración y un archivo health_spec.rb. Incluye rails_helper y declara el tipo request para disponer de helpers como response y have_http_status.

# spec/requests/health_spec.rb
require 'rails_helper'

RSpec.describe 'Health Endpoint', type: :request do
  describe 'GET /health' do
    before { get '/health' }

    it 'should return ok' do
      payload = JSON.parse(response.body)
      expect(payload).not_to be_empty
      expect(payload['api']).to eq('ok')
    end

    it 'should return status code 200' do
      expect(response).to have_http_status(:ok)
    end
  end
end

Pruebas de integración con type: :request para validar de extremo a extremo.
before ejecuta el request get '/health' antes de cada ejemplo.
response.body y JSON.parse para obtener el payload.
have_http_status(:ok) valida el status code 200 de forma expresiva.
Pruebas autodescriptivas con it 'should return ok' para claridad.

¿Qué errores comunes se observaron al correr RSpec?

Al ejecutar las pruebas primero fallan, lo esperado en TDD. Se mencionan errores típicos y su solución directa:

"Db schema rb doesn't exist yet": ejecutar rails db:migrate.
"La constante RSpec no está inicializada": usar RSpec con la S en mayúscula.
"No existe una ruta para /health": agregar la ruta y el controlador.

¿Cómo implementar el controlador y la ruta en Rails?

Crea health_controller.rb heredando de ApplicationController. Define la acción que responde con un payload mínimo y status 200 usando la constante de Rails :ok.

# app/controllers/health_controller.rb
class HealthController < ApplicationController
  def health
    render json: { api: 'ok' }, status: :ok
  end
end

Agrega la ruta para el endpoint /health apuntando a la acción health.

# config/routes.rb
Rails.application.routes.draw do
  get 'health', to: 'health#health'
end

render json: define el payload en JSON.
status: :ok traduce a 200 automáticamente.
Ruta GET /health conectada a health#health.

¿Qué incluye el payload del health check?

La idea es reflejar el estado de componentes clave. Se parte por el API: api: 'ok'. Este payload puede ampliarse para reportar otros servicios, por ejemplo, base de datos, manteniendo el formato legible y validable por pruebas de integración.

¿Tienes una variación de health check que uses en producción o más checks que te funcionen bien? Compártelo en los comentarios.

Isabid De Jesus

Hace 5 años

No he podido pasar el siguiente error...Gracias si me puede ayudar: C:\Isabid\Paginasweb\blogapi>bundle exec rspec FF

Failures:

Health endpoint GET /health should return OK Failure/Error: example.run name is not available from within an example (e.g. an it block) or from constructs that run in the scope of an example (e.g. before, let, etc). It is only available on an example group (e.g. a describe or context block).

./spec/rails_helper.rb:59:in `block (3 levels) in <top (required)>'

./spec/rails_helper.rb:58:in `block (2 levels) in <top (required)>'
Health endpoint GET /health should return status code 200 Failure/Error: example.run name is not available from within an example (e.g. an it block) or from constructs that run in the scope of an example (e.g. before, let, etc). It is only available on an example group (e.g. a describe or context block).

./spec/rails_helper.rb:59:in `block (3 levels) in <top (required)>'

./spec/rails_helper.rb:58:in `block (2 levels) in <top (required)>'

Finished in 0.1422 seconds (files took 5.52 seconds to load) 2 examples, 2 failures

Failed examples:

rspec ./spec/request/health_spec.rb:8 # Health endpoint GET /health should return OK rspec ./spec/request/health_spec.rb:13 # Health endpoint GET /health should return status code 200

Comentarios (23)23 comentarios

Victor Manuel Franco Cañon

Hace 8 años

Diego Ortiz

Enrique Andres Gonzalez Pelaez

Hace 6 años

Juan Diego Arriola

Jorge Levy Cen Avila

Fabio Leandro Fiestas Cobeñas

Ricardo de Jesús Veloz Cleto

Oscar Eduardo Info Giraldo

Angela Soler

Gerson Mayer

Cristian Mendoza

Diego Camacho

Natalia Hashimoto

Alexei Teófilo Mamani Coaquira

Hace 7 años

Bianca Florencia Piovano

Hace 4 años

Brandon Argel Verdeja Domínguez

Diana Flores

Piero Nolte

Hace 2 años

Carlos Mauro Cárdenas Fernández

Pedro Perafán Carrasco

Daniel Rodriguez

Emerson Xianai

Introducción

API de blog con Ruby on Rails y TDD

Verificar herramientas antes del proyecto Rails

Proyecto

Creación de APIs con Rails: Proyecto Blog API paso a paso

Configuración de Gemas para Pruebas en Proyectos Rails

Configuración de Gemas en Proyectos Rails: Arspec, Factory Bot y Database Cleaner

Implementación de un Health Check Endpoint en API con RSpec

Diseño de Casos de Uso y Diagramas de Entidad para Aplicaciones

Diagrama entidad relación: usuario y post

Modelado de Aplicaciones con TDD en Rails

Validaciones y Pruebas TDD en Rails: Modelos USR y Post

Implementación de Endpoints para Listar y Mostrar Posts con TDD

Implementar controlador Posts con TDD

Pruebas TDD para crear y actualizar posts

Implementación de Métodos y Manejo de Excepciones en Rails API

Active Model serializers: control total de JSON en Rails

Búsqueda y Filtrado de Posts por Título con TDD

Implementación de Búsqueda de Posts con Servicios en Rails

Problema N+1 en Rails: Detección y Solución Eficaz

Identificación y solución del problema N+1 en Rails

Flujo de Autenticación en APIs con Tokens y Proveedores

Tests con RSpec para autenticación de tokens

Autenticación con Tokens: Implementación en Rails API

Autenticación de Usuarios en Controladores Rails

Autenticación y Seguridad en CRUD de Posts en Rails

Pruebas de Creación y Actualización con Autenticación en Rails

Probando API Ruby on Rails con Postman

Caching en Aplicaciones Web: Funciones y Niveles

Aceleración de Búsquedas en Rails con Caching

Background Jobs en Rails: Conceptos y Funcionalidades

Procesamiento en Background y Envío de Correos con Rails

Envío de Correos en Rails con ActionMailer y Background Jobs

Autenticación y Autorización con JWT y Auth0 en Aplicaciones Web

Cierre

Creación de APIs con Rails: Buenas Prácticas y Features Avanzados

Implementación de un Health Check Endpoint en API con RSpec