https://github.com/abhi227070/first-flask-api
This beginner-level project introduces Flask API development. It features a simple API endpoint where users can submit two numbers in JSON format and receive their sum. The project serves as a learning tool for understanding Flask API basics, JSON data handling, and API testing with tools like Postman.
https://github.com/abhi227070/first-flask-api
flask flask-api flask-api-backend flask-api-rest json json-api python3
Last synced: 4 months ago
JSON representation
This beginner-level project introduces Flask API development. It features a simple API endpoint where users can submit two numbers in JSON format and receive their sum. The project serves as a learning tool for understanding Flask API basics, JSON data handling, and API testing with tools like Postman.
- Host: GitHub
- URL: https://github.com/abhi227070/first-flask-api
- Owner: abhi227070
- Created: 2023-09-06T07:36:01.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-30T08:23:46.000Z (about 1 year ago)
- Last Synced: 2024-03-30T09:24:37.890Z (about 1 year ago)
- Topics: flask, flask-api, flask-api-backend, flask-api-rest, json, json-api, python3
- Language: Python
- Homepage:
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# First Flask API Project
The "First Flask API Project" is a beginner-level project aimed at introducing Flask API development. It provides a simple API endpoint where users can send two numbers in JSON format, and the API will return the sum of these numbers. This project serves as a practical learning exercise for understanding the basics of building APIs with Flask, handling JSON data, and sending requests using tools like Postman.
## Table of Contents
- [Use Case](#use-case)
- [Usage](#usage)
- [Setup](#setup)
- [Running the Program](#running-the-program)
- [Testing the API](#testing-the-api)
- [Note](#note)
- [License](#license)
- [Author](#author)
## Use Case
This project's use case includes:
- Learning Flask API Development: This project serves as a hands-on introduction to Flask API development for beginners.
- Understanding JSON Data Handling: Users can learn how to handle JSON data in Flask applications, including parsing incoming requests and formatting outgoing responses.
- Practice with API Testing: Users can practice sending requests to the API using tools like Postman to test its functionality and verify responses.
## Usage
### Setup
1. Clone the repository to your local machine.
2. Install the necessary dependencies by running the following command in your terminal:
```bash
pip install -r requirements.txt
```
### Running the Program
Run the program using Gunicorn:
```bash
gunicorn app:app
```
### Testing the API
To test the API:
- Use Postman or any other API testing tool.
- Send JSON data containing two numbers to the API endpoint.
- Check the response to verify that it returns the sum of the two numbers.
## Note
- This is an API project with no graphical user interface (UI).
- Ensure data is sent in the correct JSON format to receive accurate responses.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.