Tag:PyCharm
,Flask
辫呻,flask_sqlalchemy
镰禾,Flask-Restful
[TOC]
筆者使用PyCharm來進行開發(fā)操作酌泰。
另一篇使用的是Flask-Restless
中的APIManager,本篇使用Flask-Restful
中的API來實現(xiàn)斋扰。
一、在PyCharm中新建Flask項目
新建項目時啃洋,將會聯(lián)網(wǎng)(外網(wǎng))下載并安裝flask
传货、jinja2
等。如果有錯誤提示宏娄,請自行解決網(wǎng)絡(luò)問題损离。
二、在PyCharm中的終端绝编,下載所需的包
因為新建項目的時候使用了Virtualenv
僻澎,所以安裝相關(guān)依賴貌踏,只需要在終端中,正常安裝就可以了窟勃。此時pip3安裝的包祖乳,都不是全局的,而只在當前虛擬環(huán)境中起作用秉氧。
pip3 install flask_sqlalchemy
pip3 install flask_restful
pip3 install flask-cors
pip3 install flask-restless
pip3 install flask-httpauth
pip3 install passlib
==此處和另一篇有不同眷昆。==
本例中,使用flask_sqlalchemy
和Flask-Restful
pip3 install flask_sqlalchemy
pip3 install flask_restful
關(guān)于
virtualenv
的相關(guān)信息汁咏,可以參考:virtualenv介紹及基本使用
三亚斋、導(dǎo)入包
在主文件上方,導(dǎo)入相關(guān)的包攘滩。
==此處和另一篇有不同帅刊。==
import os
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from flask_restful import Api,Resource
四、初始配置
# 創(chuàng)建Flask應(yīng)用
app = Flask(__name__)
# 獲取項目的基地址
basedir = os.path.abspath(os.path.dirname(__file__))
# 格式為mysql://{用戶名}:{密碼}@{host}:{端口}/{數(shù)據(jù)庫名}
app.config['SQLALCHEMY_DATABASE_URI']='mysql://root:@172.17.0.17:3307/flaskdb'
# 或者使用SQLite項目文件下的SQLite數(shù)據(jù)庫漂问。
# app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///' + os.path.join(basedir, 'SQL/testSQL.db')
#這個提示你設(shè)為true
app.config['SQLALCHEMY_TRACK_MODIFICATIONS']='true'
# 創(chuàng)建Flask-SQLAlchemy對象
db = SQLAlchemy(app)
這里使用SQLAlchemy
來連接一個172.17.0.17上3307端口赖瞒,用戶名是root,密碼為空蚤假,數(shù)據(jù)庫名是flaskdb
的MariaDB數(shù)據(jù)庫栏饮。
根據(jù)官方教程, Flask中常見Config用法有以下幾種。
- 直接賦值磷仰。
- 通過config的update方法一次更新多個屬性值袍嬉。
- 部分配置值可以通過屬性賦值。
- 通過文件讀取初始化config信息灶平。
關(guān)于config的部分冬竟,可以參考:讀Flask源代碼學習Python--config原理,這里不多加贅述民逼。
四泵殴、創(chuàng)建數(shù)據(jù)模型
創(chuàng)建Flask-SQLAlchemy模型(亦有成為bean的),但是要遵守下列兩點(合理)限制:
1.必須有一個主鍵類型是sqlalchemy.Integer或sqlalchemy.Unicode拼苍;
2.必須有init方法笑诅,用來初始化數(shù)據(jù)(flask_sqlalchemy.SQLAlchemy.Model已經(jīng)提供)。
==此處和另一篇有不同疮鲫。==
class Person(db.Model):
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.Unicode, unique=True)
birth_date = db.Column(db.Date)
# 要將這個Bean手動轉(zhuǎn)換為json
def to_json(self):
return {'id': self.id, 'name': self.name, 'birth_date': self.birth_date.strftime("%Y-%m-%d")}
class Computer(db.Model):
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.Unicode, unique=True)
vendor = db.Column(db.Unicode)
purchase_time = db.Column(db.DateTime)
owner_id = db.Column(db.Integer, db.ForeignKey('person.id'))
def to_json(self):
return {'id': self.id, 'name': self.name, 'vendor': self.vendor, 'purchase_time': self.purchase_time.strftime("%Y-%m-%d %H:%M:%S"), 'owner_id': self.owner_id}
flask-sqlalchemy中的SQLAlchemy可以用orm處理數(shù)據(jù)庫吆你,告別繁瑣的sql語句。文檔鏈接:http://flask-sqlalchemy.pocoo.org/2.3/
五俊犯、創(chuàng)建api
根據(jù)數(shù)據(jù)模型妇多,創(chuàng)建對應(yīng)的api。
class personList(Resource):
# get方法實現(xiàn)的內(nèi)容
def get(self):
person_list = []
# 限制查詢10個
persons = Person.query.limit(10).all()
for n in persons:
# 逐個轉(zhuǎn)化為json后添加進數(shù)組
person_list.append(n.to_json())
# 完善一下json
return {"stories":person_list}
class computerList(Resource):
# get方法實現(xiàn)的內(nèi)容
def get(self):
computer_list = []
# 限制查詢10個
computers = Computer.query.limit(10).all()
for n in computers:
# 逐個轉(zhuǎn)化為json后添加進數(shù)組
computer_list.append(n.to_json())
# 完善一下json
return {"stories":computer_list}
# 查詢person的api
api.add_resource(personList,'/api/person')
# 查詢computer的api
api.add_resource(computerList,'/api/computer')
更多關(guān)于
Flask-Restless
的內(nèi)容燕侠,請查閱官方文檔者祖,本文不在贅述立莉。文檔鏈接:https://flask-restless.readthedocs.io/en/latest/index.html
六、主程序入口
if __name__ == '__main__':
app.run(host='0.0.0.0', port=6789)
在瀏覽器中輸入地址即ip加端口進行訪問驗證:
http://127.0.0.1:6789/api/person
http://127.0.0.1:6789/api/computer
或者
http://172.17.0.38:6789/api/person
http://172.17.0.38:6789/api/computer
此時應(yīng)該得到一個json的response七问。
得到兩個json
{
"stories": [
{
"id": 1,
"name": "tt01",
"vendor": "dd",
"purchase_time": "2018-08-20 11:58:17",
"owner_id": 1
},
{
"id": 2,
"name": "tt02",
"vendor": "33",
"purchase_time": "2018-08-20 11:58:21",
"owner_id": 2
},
{
"id": 3,
"name": "tt03",
"vendor": "22",
"purchase_time": "2018-08-20 11:58:12",
"owner_id": 1
}
]
}
{
"stories": [
{
"id": 1,
"name": "wolf",
"birth_date": "2018-08-20"
},
{
"id": 2,
"name": "tst",
"birth_date": "2018-08-20"
}
]
}
七蜓耻、完整代碼
完整的flaskAPI.py
代碼如下:
import os
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from flask_restful import Api, Resource
app = Flask(__name__)
'''
根據(jù)官方教程, Flask中常見Config用法有以下幾種。
1.直接賦值械巡。
2.通過config的update方法一次更新多個屬性值刹淌。
3.部分配置值可以通過屬性賦值。
4.通過文件讀取初始化config信息讥耗。
'''
# 獲取項目的基地址
basedir = os.path.abspath(os.path.dirname(__file__))
# 格式為mysql://{用戶名}:{密碼}@{host}:{端口}/{數(shù)據(jù)庫名}
# app.config['SQLALCHEMY_DATABASE_URI'] = 'mysql://root:@172.17.0.17:3307/flaskdb'
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///' + os.path.join(basedir, 'SQL/testSQL.db')
# 這個提示你設(shè)為true
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = 'true'
# 創(chuàng)建Flask-SQLAlchemy對象
db = SQLAlchemy(app)
api = Api(app)
# 像往常一樣創(chuàng)建Flask-SQLAlchemy模型有勾,但是要遵守下列兩點(合理)限制:
# 1.必須有一個主鍵類型是sqlalchemy.Integer或sqlalchemy.Unicode。
# 2.必須有__init__方法古程,用來初始化數(shù)據(jù)(flask.ext.sqlalchemy.SQLAlchemy.Model已經(jīng)提供)蔼卡。
class Person(db.Model):
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.Unicode, unique=True)
birth_date = db.Column(db.Date)
# 要將這個Bean手動轉(zhuǎn)換為json
def to_json(self):
return {'id': self.id, 'name': self.name, 'birth_date': self.birth_date.strftime("%Y-%m-%d")}
class Computer(db.Model):
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.Unicode, unique=True)
vendor = db.Column(db.Unicode)
purchase_time = db.Column(db.DateTime)
owner_id = db.Column(db.Integer, db.ForeignKey('person.id'))
def to_json(self):
return {'id': self.id, 'name': self.name, 'vendor': self.vendor,
'purchase_time': self.purchase_time.strftime("%Y-%m-%d %H:%M:%S"), 'owner_id': self.owner_id}
class personList(Resource):
# get方法實現(xiàn)的內(nèi)容
def get(self):
person_list = []
# 限制查詢10個
persons = Person.query.limit(10).all()
for n in persons:
# 逐個轉(zhuǎn)化為json后添加進數(shù)組
person_list.append(n.to_json())
# 完善一下json
return {"stories": person_list}
class computerList(Resource):
# get方法實現(xiàn)的內(nèi)容
def get(self):
computer_list = []
# 限制查詢10個
computers = Computer.query.limit(10).all()
for n in computers:
# 逐個轉(zhuǎn)化為json后添加進數(shù)組
computer_list.append(n.to_json())
# 完善一下json
return {"stories": computer_list}
# 查詢person的api
api.add_resource(personList, '/api/person')
# 查詢computer的api
api.add_resource(computerList, '/api/computer')
@app.route('/')
def hello_world():
return 'Hello WOLF!'
if __name__ == '__main__':
db.create_all()
app.run(host='0.0.0.0', port=6789)