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)