https://github.com/7nmw/tourism_rest_api
REST API for the Federation of Sports Tourism of Russia
https://github.com/7nmw/tourism_rest_api
django django-rest-framework python rest-api swagger
Last synced: about 1 month ago
JSON representation
REST API for the Federation of Sports Tourism of Russia
- Host: GitHub
- URL: https://github.com/7nmw/tourism_rest_api
- Owner: 7nmw
- Created: 2025-02-04T11:15:10.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-04T11:20:19.000Z (over 1 year ago)
- Last Synced: 2025-02-04T12:24:59.645Z (over 1 year ago)
- Topics: django, django-rest-framework, python, rest-api, swagger
- Language: Python
- Homepage:
- Size: 3.72 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# REST API для Федерации Спортивного Туризма России (ФСТР)
Разработка REST API, обслуживающее мобильное приложение для Android и IOS, которое упростило бы туристам задачу по отправке данных о перевале и сократило время обработки запроса до трёх дней.
***
## Для начала работы необходимо установить все библиотеки
```
pip install requirements.txt
```
***
## Создана структура базы данных
Была использована база данных PostgreSQL.
***
## Логин, пароль и путь к базе данных получено из переменных окружения
* FSTR_DB_HOST: путь к базе данных;
* FSTR_DB_PORT: порт базы данных;
* FSTR_DB_LOGIN: логин, с которым происходит подключение к БД;
* FSTR_DB_PASS: пароль, с которым происходит подключение к БД.
## Реализован Rest API включающий в себя методы POST, GET и PATCH
Реализован метод POST submitData, позволяющий вносить нужную информацию:
* координаты объекта и его высоту;
* название объекта;
* несколько фотографий;
* информацию о пользователе, который передал данные о перевале:
* имя пользователя (ФИО строкой);
* почта;
* телефон.
Реализован метод GET и PATCH submitDataGetPatch позволяющий выводить информацию и вносить извемения в нее
***
## Дополнительно
Была создана документация с помощью Swagger