JoseMiracle / EXTERNAL_API_CONSUMPTION

External API Integration in Django with Django REST Framework

This repository provides an example of how to integrate an external API into a Django project using the Django REST Framework (DRF). The example demonstrates how to make API requests, handle responses, and expose the data through your own API endpoints, the endpoints are provided by [https://documenter.getpostman.com/view/1134062/T1LJjU52#intro]

Table of Contents

• Prerequisites
• Getting Started
• Setting Up the Environment
• Running the Application
• Contributing

Prerequisites

• Python (3.6+)
• Django (3.0+)
• Django REST Framework (3.12+)

Getting Started

Clone this repository to your local machine:

git clone https://github.com/JoseMiracle/EXTERNAL_API_CONSUMPTION.git
cd EXTERNAL_API_CONSUMPTION.git

Setting Up the Environment

1. Create a virtual environment (recommended):

python3 -m venv venv

2. Activate the virtual environment:

   • On macOS and Linux:

     source venv/bin/activate

   • On Windows:

     venv\Scripts\activate

3. Install the required packages:

pip install -r requirements.txt

python manage.py runserver

Running the Application

Access the DRF APIS at http://127.0.0.1:8000/api/external-api-integration/.

  e.g http://127.0.0.1:8000/api/external-api-integration/fetch-country-information/
  To test the endpoint, test with a json like
  {
    "country_name": "Canada",
    "year": "1980"
  }
  NOTE: country year from 1960-2018 is available

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvement, please open an issue or a pull request.