Health Appointment API

The Health Appointment API is a RESTful API designed to manage appointments for health professionals and patients. It allows users to schedule, update, and cancel appointments.

Documentation

OpenAPI

You can find the OpenAPI specification of the implemented endpoints in doc/openapi.yaml.
You can render it by clicking the following link.
Run OPENAPI=1 bundle exec rspec if you want to regenerate the doc/openapi.yaml file.

Simplified Class Diagram

classDiagram
    Doctor  ..> AvailabilitiesService
    Doctor  o-- WorkingHour
    Doctor  o-- Appointment

    AvailabilitiesService ..> Availability

    Availability o-- TimeSlot
    Patient o-- Appointment

    class Doctor{
      +String first_name
      +String last_name
      +int time_slot_per_client_in_min

      +get_availabilities(start_date, end_date)
    }

    class Patient{
      +String first_name
      +String last_name
    }

    class WorkingHour{
      +int day_of_week
      +Time start_time
      +Time end_time
    }

    class Appointment{
      +Time start_time
      +Time end_time
    }

    class AvailabilitiesService{
      +call() [Availability]
      +build_availability(date) Availability
    }

    class Availability{
      +Date date
      -build_slots()
    }

    class TimeSlot{
      +Time start_time
      +Time end_time
      + overlaps_with_appointments?(appointments)
    }

Loading

Issue Tracking

For completed tasks, please refer to this link.
For pending tasks that are yet to be implemented, please visit the open issues.

Installation

To install the Health Appointment API on your local machine, follow these steps:

Clone the repository:

git clone https://github.com/leobz/health_appointment_api.git

Install dependencies:

cd health_appointment_api
bundle install

Set up the database:

rails db:create db:migrate

Start the server:

rails server

Run tests

rspec spec

Gems

Gem	Description	Usage
Blueprinter	JSON Object Presenter for Ruby	Serialization
Rspec Rails	Testing library	Testing
Factory Bot Rails	Setting up Ruby objects as test data	Testing
Rspec OpenAPI	Generate OpenAPI schema from RSpec request specs	Documentation