日本免费高清视频-国产福利视频导航-黄色在线播放国产-天天操天天操天天操天天操|www.shdianci.com

學無先后，達者為師

網站首頁 編程語言 正文

如何將python代碼生成API接口_python

作者：Pomprogram ? 更新時間： 2022-11-28 編程語言

python代碼生成API接口

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

1. 安裝Flask

pip install Flask

2. 編寫Flask應用

（1）新建python文件 app.py（注意創建的Python文件名不能為flask.py，這會與Flask 本身發生沖突）

（2）在新建的文件里寫下如下內容：

#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)

首先我們導入了 Flask 類，接著我們創建一個該類的實例。第一個參數是應用模塊或者包的名稱。

如果你使用 一個單一模塊（就像本例），那么應當使用 name ，因為名稱會根據這個 模塊是按應用方式使用還是作為一個模塊導入而發生變化（可能是 ‘main’ ， 也可能是實際導入的名稱）。

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

3. 運行該Flaks應用

（1）在終端里導出 FLASK_APP 環境變量:

$ export FLASK_APP=app.py

（2）運行該程序

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

4. 使用該接口

使用過Postman（一個接口測試工具）進行測試：

這將會得到返回結果“Hello, World!”

至此，我們完成了一個簡單的將Python代碼生成API接口的實例！

更多內容請參考Flask官方文檔：

Flask官方文檔

python寫api接口實戰

操作步驟

1. 導入：import flask,json

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

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

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

5. 三種格式入參訪問接口：

  • 5.1 url格式入參：flask.request.args.get(‘id’)
  • 5.2 form-data格式入參：pwd = flask.request.values.get(‘pwd’)
  • 5.3 josn格式入參：pwd = flask.request.json.get(‘pwd’)

6. 啟動服務：api.run(port=8888,debug=True,host=‘127.0.0.1’)，開啟服務之后，就可以通過ip+端口+路徑+入參訪問接口

源碼舉例

#!/usr/bin/python3
# encoding:utf-8
import flask,json
# 實例化api，把當前這個python文件當作一個服務，__name__代表當前這個python文件
api = flask.Flask(__name__)?
?
# 'index'是接口路徑，methods不寫，默認get請求 ? ??
@api.route('/index',methods=['get'])?
# get方式訪問
def index():
? ren = {'msg':'成功訪問首頁','msg_code':200}
? #json.dumps 序列化時對中文默認使用的ascii編碼.想輸出中文需要指定ensure_ascii=False
? return json.dumps(ren,ensure_ascii=False)
?
#post入參訪問方式一：url格式參數
@api.route('/article',methods=['post'])?
def article():
? #url格式參數?id=12589&name='lishi'
? id = flask.request.args.get('id')
? ?
? if id:
? ? if id == '12589':
? ? ? ren = {'msg':'成功訪問文章','msg_code':200}
? ? else:
? ? ? ren = {'msg':'找不到文章','msg_code':400}
? else:
? ? ren = {'msg':'請輸入文章id參數','msg_code':-1}
? return json.dumps(ren,ensure_ascii=False)
?
#post入參訪問方式二：from-data（k-v）格式參數
@api.route('/login',methods=['post'])
def login():
? #from-data格式參數
? 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':'用戶名或密碼錯誤','msg_code':-1}
? else:
? ? ren = {'msg':'用戶名或密碼為空','msg_code':1001}
? return json.dumps(ren,ensure_ascii=False)
?
#post入參訪問方式二：josn格式參數 ?
@api.route('/loginjosn',methods=['post'])
def loginjosn():
? #from-data格式參數
? 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':'用戶名或密碼錯誤','msg_code':-1}
? else:
? ? ren = {'msg':'用戶名或密碼為空','msg_code':1001}
? return json.dumps(ren,ensure_ascii=False)
?
if __name__ == '__main__':
? api.run(port=8888,debug=True,host='127.0.0.1') # 啟動服務
? # debug=True,改了代碼后，不用重啟，它會自動重啟
? # 'host='127.0.0.1'別IP訪問地址

運行結果：

?* 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 -

請求方式

使用postman測試接口是否可行

如：

url:127.0.0.1:8888/login

參數：usrname=test;pwd=123456

獲取請求參數的幾種方法

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

原文鏈接：https://blog.csdn.net/Pomprogram/article/details/115770428

欄目分類
最近更新