Создание REST API на Flask — это отличный способ научиться разрабатывать веб-приложения и сервисы. Flask — это легковесный фреймворк для веб-разработки на Python, который позволяет быстро создавать приложения. В этом руководстве мы рассмотрим основные шаги по созданию простого REST API с использованием Flask.

Шаг 1: Установка Flask

Первым делом необходимо установить Flask. Это можно сделать с помощью пакетного менеджера pip. Откройте терминал и выполните следующую команду:

pip install Flask

Шаг 2: Создание базовой структуры проекта

Создайте новую папку для вашего проекта и внутри нее создайте файл app.py. Это будет основной файл вашего приложения. Структура папки может выглядеть так:

my_flask_api/
 └── app.py

Шаг 3: Написание кода для API

Теперь откройте файл app.py и добавьте следующий код:

from flask import Flask, jsonify, request

app = Flask(__name__)

# Пример данных
items = [
    {'id': 1, 'name': 'Item 1'},
    {'id': 2, 'name': 'Item 2'},
]

@app.route('/items', methods=['GET'])
def get_items():
    return jsonify(items)

@app.route('/items', methods=['POST'])
def create_item():
    new_item = request.get_json()
    items.append(new_item)
    return jsonify(new_item), 201

if __name__ == '__main__':
    app.run(debug=True)

Разберем код подробнее:

  • Импортируем необходимые модули:
    • Flask — основной класс для создания приложения.
    • jsonify — функция для преобразования данных в формат JSON.
    • request — для обработки входящих запросов.
  • Создаем экземпляр приложения с помощью Flask(__name__).
  • Определяем список items, который будет использоваться в качестве базы данных.
  • Создаем маршруты:
    • /items для GET запросов, возвращающий список всех элементов.
    • /items для POST запросов, позволяющий добавлять новые элементы.

Шаг 4: Запуск приложения

Запустите приложение, выполнив следующую команду в терминале:

python app.py

После этого ваше приложение будет доступно по адресу http://127.0.0.1:5000/items.

Шаг 5: Тестирование API

Для тестирования вашего REST API вы можете использовать такие инструменты, как Postman или curl. Например, чтобы получить список элементов, выполните следующий GET запрос:

curl http://127.0.0.1:5000/items

А для добавления нового элемента используйте POST запрос:

curl -X POST -H "Content-Type: application/json" -d '{"id": 3, "name": "Item 3"}' http://127.0.0.1:5000/items

Заключение

В этом руководстве мы рассмотрели, как создать простое REST API на Flask. Вы научились устанавливать Flask, создавать основные маршруты и обрабатывать GET и POST запросы. Это базовый пример, который можно расширять, добавляя функциональность, такую как обработка ошибок, валидация данных и интеграция с базами данных.

Теперь вы можете продолжать изучать Flask и создавать более сложные приложения!