快捷導(dǎo)航

如何將python代碼生成API接口

更新時(shí)間：2022年10月20日 14:28:48 作者：Pomprogram

這篇文章主要介紹了如何將python代碼生成API接口，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

python代碼生成API接口

如果要將我們寫(xiě)好的Python代碼生成API接口時(shí)，我們需要借助Flask框架

1. 安裝Flask

pip install Flask

2. 編寫(xiě)Flask應(yīng)用

（1）新建python文件 app.py（注意創(chuàng)建的Python文件名不能為flask.py，這會(huì)與Flask 本身發(fā)生沖突）

（2）在新建的文件里寫(xiě)下如下內(nèi)容：

#app.py
from flask import Flask
app = Flask(__name__)
@app.route('/test',methos=['post'])
def hello_world():
    return 'Hello, World!'
if __name__ == '__main__':
    app.run(debug=True)

首先我們導(dǎo)入了 Flask 類(lèi)，接著我們創(chuàng)建一個(gè)該類(lèi)的實(shí)例。第一個(gè)參數(shù)是應(yīng)用模塊或者包的名稱(chēng)。

如果你使用一個(gè)單一模塊（就像本例），那么應(yīng)當(dāng)使用 name ，因?yàn)槊Q(chēng)會(huì)根據(jù)這個(gè) 模塊是按應(yīng)用方式使用還是作為一個(gè)模塊導(dǎo)入而發(fā)生變化（可能是 ‘main’ ，也可能是實(shí)際導(dǎo)入的名稱(chēng)）。

這個(gè)參數(shù)是必需的，這樣 Flask 才能知道在哪里可以找到模板和靜態(tài)文件等東西。然后我們使用 route() 裝飾器來(lái)告訴 Flask 觸發(fā)函數(shù)的 URL 。函數(shù)名稱(chēng)被用于生成相關(guān)聯(lián)的 URL 。函數(shù)最后返回需要在用戶(hù)瀏覽器中顯示的信息。

3. 運(yùn)行該Flaks應(yīng)用

（1）在終端里導(dǎo)出 FLASK_APP 環(huán)境變量:

$ export FLASK_APP=app.py

（2）運(yùn)行該程序

$ flask run 1. Running on http://127.0.0.1:5000/

4. 使用該接口

使用過(guò)Postman（一個(gè)接口測(cè)試工具）進(jìn)行測(cè)試：

這將會(huì)得到返回結(jié)果“Hello, World!”

至此，我們完成了一個(gè)簡(jiǎn)單的將Python代碼生成API接口的實(shí)例！

更多內(nèi)容請(qǐng)參考Flask官方文檔：

Flask官方文檔

python寫(xiě)api接口實(shí)戰(zhàn)

操作步驟

1. 導(dǎo)入：import flask,json

2. 實(shí)例化：api = flask.Flask(name)

3. 定義接口訪問(wèn)路徑及訪問(wèn)方式：@api.route(’/index’,methods=[‘get/post/PUT/DELETE’])

4. 定義函數(shù)，注意需與路徑的名稱(chēng)一致，設(shè)置返回類(lèi)型并支持中文：def index(): return json.dumps(ren,ensure_ascii=False)

5. 三種格式入?yún)⒃L問(wèn)接口：

5.1 url格式入?yún)ⅲ篺lask.request.args.get(‘id’)
5.2 form-data格式入?yún)ⅲ簆wd = flask.request.values.get(‘pwd’)
5.3 josn格式入?yún)ⅲ簆wd = flask.request.json.get(‘pwd’)

6. 啟動(dòng)服務(wù)：api.run(port=8888,debug=True,host=‘127.0.0.1’)，開(kāi)啟服務(wù)之后，就可以通過(guò)ip+端口+路徑+入?yún)⒃L問(wèn)接口

源碼舉例

#!/usr/bin/python3
# encoding:utf-8
import flask,json
# 實(shí)例化api，把當(dāng)前這個(gè)python文件當(dāng)作一個(gè)服務(wù)，__name__代表當(dāng)前這個(gè)python文件
api = flask.Flask(__name__)?
?
# 'index'是接口路徑，methods不寫(xiě)，默認(rèn)get請(qǐng)求 ? ??
@api.route('/index',methods=['get'])?
# get方式訪問(wèn)
def index():
? ren = {'msg':'成功訪問(wèn)首頁(yè)','msg_code':200}
? #json.dumps 序列化時(shí)對(duì)中文默認(rèn)使用的ascii編碼.想輸出中文需要指定ensure_ascii=False
? return json.dumps(ren,ensure_ascii=False)
?
#post入?yún)⒃L問(wèn)方式一：url格式參數(shù)
@api.route('/article',methods=['post'])?
def article():
? #url格式參數(shù)?id=12589&name='lishi'
? id = flask.request.args.get('id')
? ?
? if id:
? ? if id == '12589':
? ? ? ren = {'msg':'成功訪問(wèn)文章','msg_code':200}
? ? else:
? ? ? ren = {'msg':'找不到文章','msg_code':400}
? else:
? ? ren = {'msg':'請(qǐng)輸入文章id參數(shù)','msg_code':-1}
? return json.dumps(ren,ensure_ascii=False)
?
#post入?yún)⒃L問(wèn)方式二：from-data（k-v）格式參數(shù)
@api.route('/login',methods=['post'])
def login():
? #from-data格式參數(shù)
? usrname = flask.request.values.get('usrname')
? pwd = flask.request.values.get('pwd')
? ?
? if usrname and pwd:
? ? if usrname =='test' and pwd =='123456':
? ? ? ren = {'msg':'登錄成功','msg_code':200}
? ? else:
? ? ? ren = {'msg':'用戶(hù)名或密碼錯(cuò)誤','msg_code':-1}
? else:
? ? ren = {'msg':'用戶(hù)名或密碼為空','msg_code':1001}
? return json.dumps(ren,ensure_ascii=False)
?
#post入?yún)⒃L問(wèn)方式二：josn格式參數(shù) ?
@api.route('/loginjosn',methods=['post'])
def loginjosn():
? #from-data格式參數(shù)
? usrname = flask.request.json.get('usrname')
? pwd = flask.request.json.get('pwd')
? ?
? if usrname and pwd:
? ? if usrname =='test' and pwd =='123456':
? ? ? ren = {'msg':'登錄成功','msg_code':200}
? ? else:
? ? ? ren = {'msg':'用戶(hù)名或密碼錯(cuò)誤','msg_code':-1}
? else:
? ? ren = {'msg':'用戶(hù)名或密碼為空','msg_code':1001}
? return json.dumps(ren,ensure_ascii=False)
?
if __name__ == '__main__':
? api.run(port=8888,debug=True,host='127.0.0.1') # 啟動(dòng)服務(wù)
? # debug=True,改了代碼后，不用重啟，它會(huì)自動(dòng)重啟
? # 'host='127.0.0.1'別IP訪問(wèn)地址

運(yùn)行結(jié)果：

* Serving Flask app 'monitor' (lazy loading)
* Environment: production
WARNING: This is a development server. Do not use it in a production deployment.
Use a production WSGI server instead.
* Debug mode: on
* Restarting with stat
* Debugger is active!
* Debugger PIN: 991-833-116
* Running on http://127.0.0.1:8888/ (Press CTRL+C to quit)
127.0.0.1 - - [16/Jan/2022 14:05:53] "POST /login?usrname=test&pwd=123456 HTTP/1.1" 200 -
127.0.0.1 - - [16/Jan/2022 14:08:34] "GET /index HTTP/1.1" 200 -

請(qǐng)求方式

使用postman測(cè)試接口是否可行

如：

url:127.0.0.1:8888/login

參數(shù)：usrname=test;pwd=123456

獲取請(qǐng)求參數(shù)的幾種方法

flask.request.form.get("key", type=str, default=None) 獲取表單數(shù)據(jù)，
flask.request.args.get("key") 獲取get請(qǐng)求參數(shù)，
flask.request.values.get("key") 獲取所有參數(shù)。

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: