yanixdo/flask_api_project repository overview

⁠Flask_API_Project

⁠📋 Description

Flask_API_Project — This is a simple RESTful API server built using Flask, designed to demonstrate a basic setup for creating and running API services inside a Docker container. This project includes multiple routes for testing and learning API development.

⁠🚀 Start of work

⁠1. Clone the repository

git clone https://github.com/YanaDevOps/Flask_API_Project.git
cd Flask_API_Project

⁠2. Build and run the container

docker build -t flask_api_project:1.0.0 .
docker run -d -p 8080:5000 --name flask_api_project flask_api_project:1.0.0

⁠3. Access the application

Open your browser and go to:

http://localhost:8080

⁠📂 Project structure

Flask_API_Project/
├── Dockerfile
├── app.py
├── requirements.txt
└── README.md

• Dockerfile: Configuration file for creating a Docker image.
• app.py: The main Flask application file with multiple routes.
• requirements.txt: Dependencies required for the Flask application.
• README.md: Project documentation.

⁠🌟 Functionality

• /: Main route returning a welcome message.
• /status: Returns server status in JSON format.
• /data: Accepts POST requests and returns the received data.

⁠💻 Technology

• Python 3.8
• Flask 2.2.0
• Docker

⁠👤 Author

Name: Yana Lysenko

GitHub: YanaDevOps⁠