Инструменты пользователя

Инструменты сайта


rest_api

Различия

Показаны различия между двумя версиями страницы.

Ссылка на это сравнение

Следующая версия
Предыдущая версия
rest_api [2022/08/05 15:12] – создано evgeny.polivanovrest_api [2022/08/15 20:26] (текущий) – [Инструкция по установке на сервер] evgeny.polivanov
Строка 3: Строка 3:
 Написана с использованием двух основных микро-фреймворков (библиотек): [[https://docs.sqlalchemy.org/en/14/ | SQLAlchemy]] и [[https://flask.palletsprojects.com/en/2.2.x/ | Flask]]. Написана с использованием двух основных микро-фреймворков (библиотек): [[https://docs.sqlalchemy.org/en/14/ | SQLAlchemy]] и [[https://flask.palletsprojects.com/en/2.2.x/ | Flask]].
 Тестовая версия с основным функционалом по [[https://git.sharix-app.org/ShariX_Open/open-RESTful-API/src/master | ссылке]]. Тестовая версия с основным функционалом по [[https://git.sharix-app.org/ShariX_Open/open-RESTful-API/src/master | ссылке]].
 +
 ---- ----
 +
 ===== Инструкция по установке и запуску на ПК ===== ===== Инструкция по установке и запуску на ПК =====
   - Загрузите репозиторий к себе на компьютер. Убедитесь что путь к папке не содержит пробелов (это особенность python).    - Загрузите репозиторий к себе на компьютер. Убедитесь что путь к папке не содержит пробелов (это особенность python). 
Строка 9: Строка 11:
   - Далее необходимо открыть файлы **config.py** и **connect.py**. Измените эти файлы в соответствии с вашим подключением к базе данных.   - Далее необходимо открыть файлы **config.py** и **connect.py**. Измените эти файлы в соответствии с вашим подключением к базе данных.
   - Запустите файл **run_api.bat**. Появится терминал информирующий вас о том что АПИ поднята и готова к работе. А так же отобразиться сервер к которому необходимо обращаться. Протестировать функциональность можно воспользовавшись программой [[https://www.postman.com/ | Postman]]    - Запустите файл **run_api.bat**. Появится терминал информирующий вас о том что АПИ поднята и готова к работе. А так же отобразиться сервер к которому необходимо обращаться. Протестировать функциональность можно воспользовавшись программой [[https://www.postman.com/ | Postman]] 
 +
 ---- ----
 +
 ===== Инструкция по установке на сервер ===== ===== Инструкция по установке на сервер =====
 Для начала убедитесь что на вашем сервере установлены следующие компоненты: apache2 и mod_wsgi. Для начала убедитесь что на вашем сервере установлены следующие компоненты: apache2 и mod_wsgi.
-  * Загрузите репозиторий из ветки **[[server]]** по следующему пути /var/www/__dirname__/+  * Загрузите репозиторий из ветки **[[https://git.sharix-app.org/ShariX_Open/open-RESTful-API/src/server_rest_api|server_rest_api]]** по следующему пути /var/www/__dirname__/ 
 +  * Рядом с папкой которая появилась в результате клонирования репозитория необходимо создать wsgi файл со следующим содержанием:
   * Отредактируйте файлы **config.py** и **connect.py** в соответствии с вашим подключением к базе данных.   * Отредактируйте файлы **config.py** и **connect.py** в соответствии с вашим подключением к базе данных.
-  * Создайте файл конфигурации по следующему пути: /etc/apache2/sites-available/__dirname__.conf (путь может отличаться в зависимости от сервера. Файл должен иметь следующее содержания:  +  * Создайте файл конфигурации по следующему пути: /etc/httpd2/conf/sites-available/__dirname__.conf (путь может отличаться в зависимости от сервера. Файл должен иметь следующее содержания:  
- +{{:virtualhostconf.png?nolink&400|}}
-<VirtualHost *:80>  +
- +
-ServerName mywebsite.com  +
- +
-ServerAdmin admin@mywebsite.com  +
- +
-WSGIScriptAlias / /var/www/FlaskApp/flaskapp.wsgi  +
- +
-<Directory /var/www/FlaskApp/FlaskApp/>  +
- +
-Order allow,deny Allow from all  +
- +
-</Directory>  +
- +
-Alias /static /var/www/FlaskApp/FlaskApp/static  +
- +
-<Directory /var/www/FlaskApp/FlaskApp/static/>  +
- +
-Order allow,deny Allow from all  +
- +
-</Directory>  +
- +
-ErrorLog ${APACHE_LOG_DIR}/error.log  +
- +
-LogLevel warn  +
- +
-CustomLog ${APACHE_LOG_DIR}/access.log combined  +
- +
-</VirtualHost>+
   * Измените файл в соответствии с вашим сервером, хостом и прочим.   * Измените файл в соответствии с вашим сервером, хостом и прочим.
   * Воспользуйтесь командой ''sudo a2ensite __dirname__'' для активации конфигурации (может отличаться) .   * Воспользуйтесь командой ''sudo a2ensite __dirname__'' для активации конфигурации (может отличаться) .
-  * Далее перезапустите apache2 командой ''sudo service apache2 restart'' (может отличаться) +  * Далее перезапустите apache2 командой ''sudo service httpd2 restart'' (может отличаться)  
 ---- ----
 +
 ==== Немного о структуре и коде ==== ==== Немного о структуре и коде ====
   * В файле **Models.py** расположены модели баз данных. Они построены с помощью микро-фреймворка SQLAlchemy. Они значительно упрощают работу с данными, взаимодействие с базой данных, а так же облегчают преобразование данных в json-формат.   * В файле **Models.py** расположены модели баз данных. Они построены с помощью микро-фреймворка SQLAlchemy. Они значительно упрощают работу с данными, взаимодействие с базой данных, а так же облегчают преобразование данных в json-формат.
rest_api.1659701549.txt.gz · Последнее изменение: 2022/08/05 15:12 — evgeny.polivanov

© 2022 ShariX