OutpatientSchedulerAPI

OutpatientSchedulerAPI is a simple API for managing outpatient appointments with doctors. It allows users to:

• Retrieve a list of available doctors.
• Get details about a specific doctor.
• Book an appointment with a doctor.

Live API Demo

You can try out the live API by following this link : Live API

Getting Started

To get started with this API, follow the instructions below:

Prerequisites

• Python 3.x
• Flask (install using pip install Flask)

Installation

1. Clone the repository:

git clone https://github.com/your-username/OutpatientSchedulerAPI.git
cd OutpatientSchedulerAPI

2. Run the Flask application:

python app.py

The API should now be running locally on http://127.0.0.1:5000/.

Endpoints

Get a List of Doctors

• Endpoint: /api/doctors
• Method: GET
• Description: Get a list of all available doctors.

Get Doctor Details

• Endpoint: /api/doctors/<int:doctor_id>
• Method: GET
• Description: Get details about a specific doctor by their ID.

Book an Appointment

• Endpoint: /api/appointments
• Method: POST
• Description: Book an appointment with a doctor. Provide the doctor ID and desired appointment slot in the request body.

Sample request body:

{
  "doctor_id": 1,
  "slot": {
    "day": "Monday",
    "start_time": "16:00",
    "end_time": "17:00"
  }
}

Example Usage

• To retrieve a list of doctors: GET /api/doctors
• To get details about a specific doctor (e.g., with ID 1): GET /api/doctors/1
• To book an appointment with a doctor: POST /api/appointments