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

Clase 7 de 33 • Curso de Creación de APIs con Ruby on Rails

Resumen

Diseñar los requerimientos y las entidades de un blog exige un método claro. Aquí se definen las funcionalidades por tipo de usuario y se mapean a endpoints, preparando el terreno para el diagrama de entidad de relación que modelará las tablas necesarias. El enfoque es directo: priorizar lo esencial para construir una base sólida.

¿Qué casos de uso y endpoints se requieren?

Se parte de un diagrama de casos de uso para verificar acciones y endpoints que deben soportarse según el tipo de usuario. Esto orienta el alcance funcional y evita omisiones.

¿Qué puede hacer un usuario no autenticado?

Autenticación: realizar login o crear cuenta, resumido como auth.
Listar posts publicados.
Filtrar o buscar posts.

¿Qué puede hacer un usuario autenticado?

Hacer logout y no crear cuenta.
Crear posts nuevos.
Crear borradores.
Publicar borradores para que sean accesibles por otros usuarios.
Editar un post existente.
Listar y filtrar o buscar posts publicados.

Este mapeo entre casos de uso y endpoints facilita priorizar y validar las acciones que realmente aportan valor.

¿Cómo se modelarán las entidades en el diagrama er?

Luego del análisis de casos de uso, se crea un diagrama de entidad de relación para decidir qué tablas guardar y cómo representar la información que el blog necesita. El objetivo: definir una estructura de datos que refleje con fidelidad las acciones ya establecidas.

¿Qué habilidades y conceptos clave se aplican?

Se aplican habilidades y conceptos fundamentales para pasar de la idea a un diseño funcional y consistente.

Diseño de requerimientos: definición de funcionalidades por tipo de usuario.
Diagrama de casos de uso: verificación de acciones y endpoints necesarios.
Tipos de usuario: autenticado y no autenticado.
Autenticación: login, creación de cuenta y logout como flujos base.
Creación de contenido: creación de posts, manejo de borradores, publicación de borradores, edición de posts existentes.
Búsqueda y filtrado: exploración de posts publicados.
Mapeo casos de uso–endpoints: relación directa entre necesidades funcionales y endpoints a soportar.
Diagrama de entidad de relación: identificación de tablas para guardar la información del blog.

¿Qué agregarías o ajustarías en estos casos de uso para tu propio blog? Comparte tus ideas en los comentarios.

Victor Manuel Franco Cañon

student•

Me agrada mucho esta metodología de explicar que se hará antes de hacer algo!!!

Mario Vizcaino

student•

si, se entiende mucho más fácil.

Victor Manuel Franco Cañon

student•

Si, es como la ruta de lo que hay que hacer… se nota planeado y nada de improvisación. Me agrada mucho.

Luis Nabor

student•

Hola al implementar el paso a paso que hay en el curso puedes notar que la documentación de git hub ha cambiado un poco pero no afecta mucho a este error:

bundle exec rspec

An error occurred while loading ./spec/requests/health_spec.rb.
Failure/Error:
  Shoulda::Matchers.configure do | config |
    config.integrate do |with|
      with.test_framework :rspec
  
      with.library :active_record
      with.library :active_model
      with.library :action_controller
  
      with.library :rails
    end

NameError:
  uninitialized constant Shoulda
# ./spec/rails_helper.rb:12:in `<top (required)>'
# ./spec/requests/health_spec.rb:1:in `require'
# ./spec/requests/health_spec.rb:1:in `<top (required)>'
# ------------------
# --- Caused by: ---
# NameError:
#   uninitialized constant Shoulda
#   ./spec/rails_helper.rb:12:in `<top (required)>'
No examples found.


Finished in 0.01366 seconds (files took 1.22 seconds to load)
0 examples, 0 failures, 1 error occurred outside of examples

Lo que realmente afecta es no incluir estas tres librerias:

# Add additional requires below this line. Rails is not loaded until this point!
require 'database_cleaner'
require 'shoulda-matchers'
require 'factory_bot_rails'

en el archivos /spec/rails.helper.rb lo cual no se menciona en los paso a paso del video, una vez la incluyas y si tenias el error que te relaciono arriba posiblemente al ejecutar este comando: bundle exec rspec

la felicidad llegue a ti con un mensaje como este:

Failures:

  1) Health Endpoint GET health should return OK
     Failure/Error: before { get 'health'}
     
     URI::InvalidURIError:
       bad URI(is not URI?): "http://www.example.com:80health"
     # ./spec/requests/health_spec.rb:7:in `block (3 levels) in <top (required)>'
     # ./spec/rails_helper.rb:65:in `block (3 levels) in <top (required)>'
     # ./spec/rails_helper.rb:64:in `block (2 levels) in <top (required)>'

  2) Health Endpoint GET health should return status code 200
     Failure/Error: before { get 'health'}
     
     URI::InvalidURIError:
       bad URI(is not URI?): "http://www.example.com:80health"
     # ./spec/requests/health_spec.rb:7:in `block (3 levels) in <top (required)>'
     # ./spec/rails_helper.rb:65:in `block (3 levels) in <top (required)>'
     # ./spec/rails_helper.rb:64:in `block (2 levels) in <top (required)>'

Finished in 0.48693 seconds (files took 4.13 seconds to load)
2 examples, 2 failures

Failed examples:

rspec ./spec/requests/health_spec.rb:9 # Health Endpoint GET health should return OK
rspec ./spec/requests/health_spec.rb:15 # Health Endpoint GET health should return status code 200

Kevin FG

student•

Que gran curso, todo bien hasta ahora 2022. Estoy usando Rails 6 y todas las gemas las instale sin indicar la version especifica. (las ultimas). La config cambia un poco pero nada que buscando en la documentacion no se resuelve. Todo lo demas todo bien. Con lo dificil que es encontrar cursos de Rails en espanol.

Gustavo Fabian Sandoval

student•

Excelente!

bundle exec rspec

An error occurred while loading ./spec/requests/health_spec.rb.
Failure/Error:
  Shoulda::Matchers.configure do | config |
    config.integrate do |with|
      with.test_framework :rspec
  
      with.library :active_record
      with.library :active_model
      with.library :action_controller
  
      with.library :rails
    end

NameError:
  uninitialized constant Shoulda
# ./spec/rails_helper.rb:12:in `<top (required)>'
# ./spec/requests/health_spec.rb:1:in `require'
# ./spec/requests/health_spec.rb:1:in `<top (required)>'
# ------------------
# --- Caused by: ---
# NameError:
#   uninitialized constant Shoulda
#   ./spec/rails_helper.rb:12:in `<top (required)>'
No examples found.


Finished in 0.01366 seconds (files took 1.22 seconds to load)
0 examples, 0 failures, 1 error occurred outside of examples

Failures:

  1) Health Endpoint GET health should return OK
     Failure/Error: before { get 'health'}
     
     URI::InvalidURIError:
       bad URI(is not URI?): "http://www.example.com:80health"
     # ./spec/requests/health_spec.rb:7:in `block (3 levels) in <top (required)>'
     # ./spec/rails_helper.rb:65:in `block (3 levels) in <top (required)>'
     # ./spec/rails_helper.rb:64:in `block (2 levels) in <top (required)>'

  2) Health Endpoint GET health should return status code 200
     Failure/Error: before { get 'health'}
     
     URI::InvalidURIError:
       bad URI(is not URI?): "http://www.example.com:80health"
     # ./spec/requests/health_spec.rb:7:in `block (3 levels) in <top (required)>'
     # ./spec/rails_helper.rb:65:in `block (3 levels) in <top (required)>'
     # ./spec/rails_helper.rb:64:in `block (2 levels) in <top (required)>'

Finished in 0.48693 seconds (files took 4.13 seconds to load)
2 examples, 2 failures

Failed examples:

rspec ./spec/requests/health_spec.rb:9 # Health Endpoint GET health should return OK
rspec ./spec/requests/health_spec.rb:15 # Health Endpoint GET health should return status code 200

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

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