https://github.com/emmyaniedev/hngx-stage1-number-classifier-api
A RESTful API for analyzing numbers, determining their mathematical properties, and fetching fun facts. Built as part of my HNG Stage 1 task.
https://github.com/emmyaniedev/hngx-stage1-number-classifier-api
rest-api third-party-api
Last synced: 5 days ago
JSON representation
A RESTful API for analyzing numbers, determining their mathematical properties, and fetching fun facts. Built as part of my HNG Stage 1 task.
- Host: GitHub
- URL: https://github.com/emmyaniedev/hngx-stage1-number-classifier-api
- Owner: EmmyAnieDev
- Created: 2025-02-03T01:48:43.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-10T11:48:12.000Z (3 months ago)
- Last Synced: 2025-02-17T23:12:36.020Z (3 months ago)
- Topics: rest-api, third-party-api
- Language: Python
- Homepage: https://number-classifier-api-production.up.railway.app/api/classify-number
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Number Classification API
A RESTful API that analyzes numbers and returns their mathematical properties along with interesting facts.
## Project Structure
```
number-classification-api/
├── app.py # Application entry point and route
├── services/
│ └── number_api_service.py # Business logic
├── utils/
│ ├── constants.py # Configuration constants
│ └── number_properties.py # Mathematical utilities
├── requirements.txt
└── README.md
```
## Features
- Determines if a number is **prime**
- Checks if a number is **perfect**
- Identifies **Armstrong numbers**
- Calculates **digit sum**
- Classifies numbers as **even/odd**
- Fetches fun facts from the **Numbers API**
- **CORS enabled**
- Handles invalid input gracefully
## Requirements
- Python 3.8+
- Flask
- Flask-CORS
- Requests
- gunicorn
## Installation
1. **Clone the repository:**
```bash
git clone https://github.com/EmmyAnieDev/hngx-stage1-number-classifier-api.git
cd hngx-stage1-number-classifier-api
```
2. Create a virtual environment and activate it:
```bash
python -m venv venv
source venv/bin/activate # On Windows use: venv\Scripts\activate
```
3. Install dependencies:
```bash
pip install -r requirements.txt
```
## Running the Application
1. Start the server:
```bash
python app.py
```
2. The API will be available at `http://localhost:8000`
## API Documentation
### Method: `GET`
### Endpoint: `/api/classify-number`
### Query Parameter: `number` (required): The integer to analyze
#### Full URL for Localhost Testing: Analyzes a number and returns its properties.
```bash
http://localhost:8000/api/classify-number?number=5
```
#### Success Response (200 OK)
```json
{
"number": 5,
"is_prime": true,
"is_perfect": false,
"properties": [
"armstrong",
"odd"
],
"digit_sum": 5,
"fun_fact": "5 is the third prime number."
}
```
#### Error Response (400 Bad Request)
```json
{
"number": "letter",
"error": true
}
```
#### Occurs when an invalid input (like a letter/alphabet) is provided.
```json
{
"number": "null",
"error": true
}
```
#### Occurs when the `number` parameter is missing from the request.
```json
{
"number": "",
"error": true
}
```
#### Occurs when the `number` parameter has an empty value.
## Deployment
The API is deployed on Railway and can be accessed at:
```
https://number-classifier-api-production.up.railway.app/
```
## Quick Test
To test the full URL with the parameter:
### Method: `GET`
```bash
curl "https://number-classifier-api-production.up.railway.app/api/classify-number?number=5"
```