GWLocationAPI

GWLocationAPI

Потрясающий пример/загрузочный проект RESTful API Python и Flask с элементами ООП и MVC, модульным тестированием, сохраняемостью через SQLAlchemy, безопасностью и аутентификацией, коллажами и некоторыми другими интересными темами в одном пакете.

---

Работа в процессе

Это работа в стадии разработки...

---

Настраивать

Быстрые шаги для начала:

• Клонируйте этот проект из терминала/командной строки: git clone https://github.com/RHT/GWLocationAPI.git
• Запустите virtualenv venv (подробнее о настройке собственной виртуальной среды — прочтите мои инструкции ниже: Как настроить виртуальную среду? )
• Активируйте source venv/bin/activate (Mac/Linux) или ./venv/Scripts/activate.bat ( Windows ).
• Установите предопределенные требования pip install -r requirements.txt
• Запустите приложение python app.py
• Откройте http://localhost:5000/ (следуйте всем остальным инструкциям в этом документе, чтобы узнать, как выполнить тестовый запуск).
• Предварительный просмотр в реальном времени см. на странице https://gw-location-api.herokuapp.com и протестируйте различные вызовы.

Как настроить виртуальную среду?

Установите virtualenv из терминала/командной строки.

Mac/Linux/Windows: pip install virtualenv или pip3.6 install virtualenv

Инициализировать virtualenv

Это инициализирует virtualenv в каталоге вашего проекта.

Mac/Linux/Windows: virtualenv venv или virtualenv venv --python=3.6

Чтобы активировать virtualenv

Это активирует вашу виртуальную среду. Все pip install внутри каталога вашего проекта будут влиять только на вашу виртуальную среду, а не на вашу систему.

Mac и Linux: source venv/bin/activate

Windows: ./venv/Scripts/activate.bat

Как деактивировать виртуальную среду моего проекта?

Остановить/деактивировать virtualenv

Это остановит ваш сеанс виртуальной среды.

Находясь в каталоге вашего проекта, введите следующее (Mac/Linux/Windows): deactivate

---

Тестирование через cURL

ПОЛУЧИТЬ ИНДЕКС

curl "https://gw-location-api.herokuapp.com"

НАЙТИ МЕСТО

curl "https://gw-location-api.herokuapp.com/find/bangkok"

ПОЛУЧИТЬ ВСЕ МЕСТА

curl "https://gw-location-api.herokuapp.com/locations/"

МЕСТОПОЛОЖЕНИЕ ПО ИДЕНТИФИКАТОРУ

curl "https://gw-location-api.herokuapp.com/locations/1"

МЕСТО ПОЧТЫ (?)

curl -i -X "POST" "https://gw-location-api.herokuapp.com/locations/"

ОБНОВИТЬ МЕСТО (?)

curl -i -X "PUT" "https://gw-location-api.herokuapp.com/locations/1"

УДАЛИТЬ МЕСТО (?)

curl -i -X "DELETE" "https://gw-location-api.herokuapp.com/locations/1"

? = Требуется аутентификация ( создайте пользователя внутри сгенерированного файла базы данных, пока он не будет добавлен в будущих версиях ).

---

Запуск модульного теста

Запустите python tests/model/test_user.py

---

Живой образец

https://gw-location-api.herokuapp.com

---

Лицензия

Copyright ©2018 – Роберт Ханссон-Торнеус (RHT)