Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lahcenezzara/bmi-calculator-fastapi

BMI Calculator FastAPI Python
https://github.com/lahcenezzara/bmi-calculator-fastapi

api backend bmi-calculator body-mass-index cors fastapi fitness health microservices pydantic python rest-api uvicorn web-api web-development

Last synced: about 1 month ago
JSON representation

BMI Calculator FastAPI Python

Host: GitHub
URL: https://github.com/lahcenezzara/bmi-calculator-fastapi
Owner: LahcenEzzara
License: mit
Created: 2024-07-19T16:19:17.000Z (5 months ago)
Default Branch: main
Last Pushed: 2024-07-19T16:23:30.000Z (5 months ago)
Last Synced: 2024-07-19T21:21:26.940Z (5 months ago)
Topics: api, backend, bmi-calculator, body-mass-index, cors, fastapi, fitness, health, microservices, pydantic, python, rest-api, uvicorn, web-api, web-development
Language: Python
Homepage: https://bmi-calculator-fastapi.onrender.com
Size: 3.91 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# BMI Calculator FastAPI

This is a simple Body Mass Index (BMI) calculator API built with FastAPI. It calculates BMI based on user-provided weight and height, and returns a message and image indicating the BMI category.

## Features

- Calculate BMI using weight and height
- Return BMI value, message, and image representing the BMI category
- CORS setup to allow requests from web browsers

## Endpoints

- **GET /**: Returns a welcome message.
- **GET /calculate_bmi**: Calculates BMI based on query parameters `weight` and `height`.

## Getting Started

### Prerequisites

- Python 3.7+
- FastAPI
- Uvicorn
- Pydantic

### Installation

1. Clone the repository:
```bash
git clone https://github.com/LahcenEzzara/bmi-calculator-fastapi.git
cd bmi-calculator-fastapi
```

2. Create and activate a virtual environment:
```bash
python -m venv venv
source venv/bin/activate # On Windows, use `venv\Scripts\activate`
```

3. Install the required packages:
```bash
pip install fastapi uvicorn pydantic
```

### Running the Server

1. Start the FastAPI server using Uvicorn:
```bash
uvicorn app:app --reload
```

2. The API will be available at `http://127.0.0.1:8000`.

### Usage

- **GET /**:
```bash
curl -X 'GET' \
'http://127.0.0.1:8000/' \
-H 'accept: application/json'
```
Response:
```json
{
"message": "Hello, Python"
}
```

- **GET /calculate_bmi**:
```bash
curl -X 'GET' \
'http://127.0.0.1:8000/calculate_bmi?weight=70&height=1.75' \
-H 'accept: application/json'
```
Response:
```json
{
"bmi": 22.857142857142858,
"message": "You have a normal weight, keep it up.",
"image": "2"
}
```

## Acknowledgements

- FastAPI
- Pydantic
- Uvicorn

## Copyright

This project is developed by Lahcen Ezzara and is protected under the MIT License. Please see the [LICENSE](LICENSE) file for more details.