Python: Implementacja REST API z użyciem Flask

Ta dokumentacja jest częścią przewodnika Tworzenie REST API. Pełny przewodnik znajdziesz tutaj: Przewodnik krok po kroku po budowie REST API z Flask w Pythonie.

👋 Witamy w dokumentacji Stackhero!

Stackhero oferuje gotowe do użycia Python cloud, które upraszcza proces wdrażania:

  • Wdrażaj swoją aplikację na produkcję w kilka sekund za pomocą prostego git push.
  • Korzystaj z własnej nazwy domeny, z automatyczną konfiguracją certyfikatu HTTPS – bezpieczne połączenia są obsługiwane za Ciebie.
  • Polegaj na automatycznych backupach, aktualizacjach jednym kliknięciem oraz przewidywalnych kosztach, dzięki czemu możesz skupić się na kodzie, a nie na zarządzaniu infrastrukturą.
  • Korzystaj z wysokiej wydajności i bezpieczeństwa na prywatnej, dedykowanej infrastrukturze. Twoje środowisko jest odizolowane i chronione.

Oszczędzaj czas i upraszczaj swój workflow: Twój kod może działać na Python cloud hosting Stackhero już w 5 minut.

Teraz możesz napisać kod swojego API.

Utwórz plik o nazwie app.py i dodaj poniższy kod:

import os
from dotenv import load_dotenv
from flask import Flask, jsonify, request

# Ładowanie zmiennych środowiskowych z .env dla środowisk innych niż produkcyjne
if os.environ.get('ENV') != 'production':
    load_dotenv()

app = Flask(__name__)

# Przykładowe dane zadań
tasks = [
    {
        'id': 1,
        'title': 'Buy groceries',
        'description': 'Milk, Cheese, Pizza, Fruits',
        'done': False
    },
    {
        'id': 2,
        'title': 'Learn Python',
        'description': 'Learn Python programming basics',
        'done': False
    }
]

@app.route('/api/tasks', methods=['GET'])
def get_tasks():
    return jsonify({'tasks': tasks})

@app.route('/api/tasks/<int:task_id>', methods=['GET'])
def get_task(task_id):
    task = [task for task in tasks if task['id'] == task_id]
    if not task:
        return jsonify({'error': 'Task not found'}), 404
    return jsonify({'task': task[0]})

@app.route('/api/tasks', methods=['POST'])
def create_task():
    if not request.json or 'title' not in request.json:
        return jsonify({'error': 'Title is required'}), 400
    task = {
        'id': tasks[-1]['id'] + 1,
        'title': request.json['title'],
        'description': request.json.get('description', ""),
        'done': False
    }
    tasks.append(task)
    return jsonify({'task': task}), 201

if __name__ == '__main__':
    if os.environ.get('ENV') == 'production':
        app.run()
    else:
        app.run(host='0.0.0.0', port=8080, debug=True)

Serwer możesz uruchomić poleceniem:

python app.py

Dzięki host='0.0.0.0' Twoje API jest dostępne przez przeglądarkę podczas korzystania z Code-Hero. Odwiedź http://<XXXXXX>.stackhero-network.com:8080/api/tasks, zamieniając <XXXXXX> na swoją domenę Code-Hero.