Пример приложения FlaskRestful

Описание

Простой пример интернет-магазина, написанный с использованием архитектуры FlaskRestful.

Структура проекта```shell script

. ├── alipay # Папка с публичным и приватным ключами для Alipay │   ├── alipay_public_key.txt # Публичный ключ │   └── app_private_key.txt # Приватный ключ ├── main # Основная директория приложения │   ├── apis # Директория с API │   │   ├── admin # Администратор │   │   │   ├── admin_api.py │   │   │   ├── init.py │   │   │   └── utils.py │   │   ├── api_constant.py # Константы API │   │   ├── goods # Управление товарами │   │   │   ├── goods_api.py │   │   │   ├── init.py │   │   ├── init.py # Регистрация API │   │   ├── user # Пользователи │   │   │   ├── cart_api.py # Корзина │   │   │   ├── init.py │   │   │   ├── order_api.py # Заказы │   │   │   ├── pay_api.py # Платежи │   │   │   ├── user_api.py # Пользователи │   │   │   └── utils.py │   │   └── utils.py │   ├── ext.py # Регистрация расширений Flask │   ├── init.py # Регистрация приложения │   ├── models # Модели │   │   ├── admin # Модели администратора │   │   │   ├── admin_model.py │   │   │   ├── init.py │   │   ├── goods # Модели товаров │   │   │   ├── goods_model.py │   │   │   ├── init.py │   │   ├── init.py # Базовые модели (включая шифрование паролей) │   │   └── user # Модели пользователей │   │   ├── init.py │   │   └── user_model.py │   └── settings.py # Параметры конфигурации проекта ├── manage.py # Файл запуска, аналогичный Django ├── requires.txt ├── static └── templates

1. Клонировать проект

```shell script
git clone https://gitee.com/thepoy/FlaskRestfulDemo.git

2. Перейти в основную директорию проекта и отредактировать файл конфигурации settings.py

cd FlaskRestfulDemo
vim main/settings.py  # Можно использовать другой текстовый редактор

Основные параметры для изменения:

• 7 строка

SERVER_HOST = 'http://127.0.0.1:5000/'  # IP и порт можно настроить по желанию

• 21 строка

CACHE_REDIS_URL = 'redis://172.17.0.3:6379'  # В проекте Redis и MySQL используются контейнеры Docker, их нужно заменить на реальные адреса

• Строка 39 до 44

MAIL_SERVER = 'smtp.office365.com'  # Сервер отправки почты
MAIL_USERNAME = 'flask_restful_test@outlook.com'  # Ваша почта
MAIL_PASSWORD = 'flask_restful_mail'  # Пароль вашей почты
MAIL_PORT = 587  # По умолчанию 25
MAIL_USE_TLS = True
MAIL_DEFAULT_SENDER = (NAME, MAIL_USERNAME)  # Имя отправителя и адрес электронной почты, NAME на 9 строке

• Строка 69 до 78

db_info = {
    'ENGINE': 'mysql',
    'DRIVER': 'pymysql',
    'USER': 'root',  # Имя пользователя MySQL для тестирования
    'PASSWORD': '',  # Пароль пользователя MySQL
    'HOST': '172.17.0.2',  # IP сервера MySQL
    'PORT': 3306,  # Порт MySQL
    'NAME': 'restful'  # Не изменять
}

3. Создание базы данных

CREATE DATABASE IF NOT EXISTS restful;

Если по умолчанию кодировка не utf-8, при создании необходимо указать кодировку utf-8

4. Миграция базы данных, создание таблиц В корневой директории проекта последовательно выполните следующие команды```shell script python manage.py db init python manage.py db migrate python manage.py db upgrade

5. Запуск проекта
   В переменных окружения добавьте переменную окружения, для Linux и MacOS выполните:

```shell script
export FLASK_ENV=development

В корневой директории проекта выполните следующие команды (необходимо два терминальных окна или вкладки)

python manage.py runserver

celery worker -A celery_worker.celery -l info

Теперь celery запущен, и Demo начал работу.

Инструкция по использованию

Все действия выполняются на примере http://127.0.0.1:5000

1. Создание администратора требует прав суперпользователя, поэтому сначала нужно добавить аккаунт суперпользователя:

   Откройте main/apis/admin/admin_api.py, закомментируйте 33 строку кода

   @permission_required(PERMISSION_SU)

2. Подождите перезапуск сервера разработки, затем используйте Postman или другой инструмент для работы с RESTful API, откройте http://127.0.0.1:5000/admin/register/ методом post, следуйте инструкциям и отправьте параметры username и password, затем отмените комментирование шага 1, теперь у вас есть аккаунт суперпользователя.

3. xxxx