Weather Forecast API using DRS

Summary and description:

RESTful API that provides weather forecasts based on user queries, including location, date, and time. Utilize HTTP methods like GET to retrieve forecasts and POST to submit queries. Developed using Django Rest Framework.

My Weather Forecast API is a Django Rest Framework (DRF) based application that provides weather forecast information. It allows users to access weather forecasts based on location, date, and time. The API is built using Django and DRF and is deployed using Railway. You can test it [here].

Installation prerequisites

To set up the Weather Forecast API on your PC, please follow these steps:

Make sure you have Python and pip installed. You can check the Python version by running py --version.
Install Django by running: pip install django
Install Django Rest Framework (DRF): pip install djangorestframework

Usage (test)

To use the Weather Forecast API, follow these instructions:

Visit https://web-production-5ae0.up.railway.app/ or go to the development server address if you got it locally.
APP: Access the API endpoint to view all available weather information by visiting /forecasts. This will display all the weather information, ordered by id: https://web-production-5ae0.up.railway.app/forecasts/

Note. The composite primary key is: location, date, time. You won't be able to POST a new record if a record with these parameters already exists. The remaining fields are: temperature and description.

GET: Filter the weather information by location by adding ?field=string to the API endpoint URL. For example, /forecasts/?location=Florence will display weather forecasts for Florence. The complete list of possible requests (includes 'multi field' stuff) is as follows:
LOGIN To be able to perform administrative actions like creating or deleting forecasts, you can log as superuser in to the /admin route.

I already created one superuser with these credentials: username: niccoboa and password: niccoboa. You can use it to test the app of course.

To logout, just go again to /admin and click on logout on top or directly type: /admin/logout

POST:Once logged in you ar able to POST. Go back to /forecasts/. At the bottom of the page you will find the HTML form provided by DRS. You can add a record by writing, in the content area, something like this:

{
       "location":    "Dublin",
       "date":        "2023-06-18",
       "time":        "23:30:00",
       "temperature": "12.30",
       "description": "Cloudy"
}

Bonus tip. You can as well post multiple forecasts at the same time, by providing an array of records: [{"location": "Dublin", "date": "2023-06-18", "time": "23:30:00", "temperature": "12.30", "description": "Cloudy" }, {"location": "New York", "date": "2023-06-19", "time": "12:30:00", "temperature": "15.40", "description": "Sunny"}]

DELETE: you can delete a single record by id by going to the specified forecast (for example: /forecasts/?id=10 and then clicking on DELETE red button on top of the page.

Credits

The Weather Forecast API utilizes the following technologies and frameworks:

Django: https://www.djangoproject.com/
Django Rest Framework: https://www.django-rest-framework.org/
Railway: https://railway.app/

Contact