jikAPI (Jobs In Kenya Live API) is a Job Search REST API that provides job postings data to users. It allows users to search for job opportunities that have been recently posted by employers in Kenya.
The API is built using the Flask framework and utilizes PostgreSQL as the database management system.
The API provides the following endpoints for accessing job postings data:
GET /api/v2/jobs: Retrieves a list of available job postings.POST /api/v2/jobs: Adds a new job posting to the database.POST /api/v2/jobs/date: Retrieves job postings posted on a specific date.POST /api/v2/jobs/keyword: Retrieves jobs with specific keywords.GET /api/v2/jobs/{id}: Retrieves a specific job posting with the given id.DELETE /api/v2/jobs/{id}: Deletes a specific job posting with the given id.PATCH /api/v2/jobs/{id}: Updates a specific job posting with the given id.
To use the API, make HTTP requests to the appropriate endpoint with the desired parameters. The API will return a JSON response with the requested data.
Clone the repository using the following command.
git clone https://github.com/Njoguu/jikAPI.git-
Make sure you have docker installed.
-
Navigate to the folder structure then build the container with the command
docker build -t <your-image-name> .- Run the container with the command
docker run -d -p 5000:5000 <your-image-name>Go to http://127.0.0.1:5000
To run the API tests, use the following command: pytest
The API uses Swagger for API documentation. To access the documentation, navigate to /api/v2/docs in your web browser when the API is running.