https://github.com/dowusubekoe-dev/demo-movie-api

https://github.com/dowusubekoe-dev/demo-movie-api

api docker dockerfile git json linux-shell postman-test python

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/dowusubekoe-dev/demo-movie-api
• Owner: dowusubekoe-dev
• License: mit
• Created: 2024-12-18T01:13:46.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-12-18T01:56:35.000Z (about 1 month ago)
• Last Synced: 2024-12-18T02:27:59.380Z (about 1 month ago)
• Topics: api, docker, dockerfile, git, json, linux-shell, postman-test, python
• Language: Python
• Homepage:
• Size: 11.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Simple REST API locally on a Linux server using Python with the Flask Framework

## Prerequisites:

1. Linux server (local or remote).

2. Python (version 3.x).

3. pip (Python's package installer).

### Steps to Build the API:

1. Install Required Tools

Open the terminal on your Linux server and run:

```bash

# Install Python3 and pip if not already installed

sudo apt update

sudo apt install python3 python3-pip -y

```

2. Install Flask

Use pip to install Flask:

```bash

pip3 install flask

```

3. Create the API Project Directory

Navigate to your preferred folder and create a new project directory:

```bash

mkdir my_api

cd my_api

```

4. Write the API Code

Open the app.py file using a text editor (like nano, vim, or VSCode), and paste the following code:

```python

from flask import Flask, jsonify, request

app = Flask(__name__)

# Root Endpoint

@app.route('/')

def home():

    return jsonify({"message": "Welcome to my API!"})

# Simple GET Endpoint

@app.route('/api/greet', methods=['GET'])

def greet():

    name = request.args.get('name', 'World')

    return jsonify({"greeting": f"Hello, {name}!"})

# Simple POST Endpoint

@app.route('/api/echo', methods=['POST'])

def echo():

    data = request.json

    return jsonify({"received_data": data})

# Run the Flask app

if __name__ == '__main__':

    app.run(host='0.0.0.0', port=5000, debug=True)

```

5. Run the API Server

Start the Flask API server by running:

```bash

python3 app.py

```

By default, Flask will start the server on port 5000.

6. Test Your API

a) Test the Root Endpoint

Open your browser or use curl:

```bash

curl http://127.0.0.1:5000/

```

Expected Output:

```json

{"message": "Welcome to my API!"}

```

b) Test the GET Endpoint with Query Parameters

```bash

curl "http://127.0.0.1:5000/api/greet?name=John"

```

Expected Output:

```json

{"greeting": "Hello, John!"}

```

c) Test the POST 

Use curl to send JSON data:

```bash

curl -X POST -H "Content-Type: application/json" -d '{"key": "value"}' http://127.0.0.1:5000/api/echo

```

Expected Output:

```json

{"received_data": {"key": "value"}}

```