GWLocationAPI

GW位置API

一個很棒的 Python 和 Flask RESTful API 範例/Bootstrap 項目，在一個套件中包含 OOP 和 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/"

按 ID 定位

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

---

執照

版權所有 ©2018 – 羅伯特漢森-託內烏斯 (RHT)