利用python寫api接口實戰(zhàn)指南

更新時間：2022年05月11日 11:44:36 作者：說笑談古松

api接口在我們開發(fā)中的重要性相信大家都這篇文章主要給大家介紹了關(guān)于利用python寫api接口實戰(zhàn)的相關(guān)資料,文中通過實例代碼介紹的非常詳細(xì),需要的朋友可以參考下

一、操作步驟

導(dǎo)入：import flask,json
實例化：api = flask.Flask(name)
定義接口訪問路徑及訪問方式：@api.route(’/index’,methods=[‘get/post/PUT/DELETE’])
定義函數(shù)，注意需與路徑的名稱一致，設(shè)置返回類型并支持中文：def index(): return json.dumps(ren,ensure_ascii=False)
三種格式入?yún)⒃L問接口：
5.1 url格式入?yún)ⅲ?code>flask.request.args.get(‘id’)
5.2 form-data格式入?yún)ⅲ?code>pwd = flask.request.values.get(‘pwd’)
5.3 josn格式入?yún)ⅲ?code>pwd = flask.request.json.get(‘pwd’)
啟動服務(wù)：api.run(port=8888,debug=True,host=‘127.0.0.1’)，開啟服務(wù)之后，就可以通過ip+端口+路徑+入?yún)⒃L問接口

二、源碼舉例

#!/usr/bin/python3
# encoding:utf-8
import flask,json
# 實例化api，把當(dāng)前這個python文件當(dāng)作一個服務(wù)，__name__代表當(dāng)前這個python文件
api = flask.Flask(__name__) 
 
# 'index'是接口路徑，methods不寫，默認(rèn)get請求     
@api.route('/index',methods=['get']) 
# get方式訪問
def index():
  ren = {'msg':'成功訪問首頁','msg_code':200}
  #json.dumps 序列化時對中文默認(rèn)使用的ascii編碼.想輸出中文需要指定ensure_ascii=False
  return json.dumps(ren,ensure_ascii=False)
 
#post入?yún)⒃L問方式一：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':'成功訪問文章','msg_code':200}
    else:
      ren = {'msg':'找不到文章','msg_code':400}
  else:
    ren = {'msg':'請輸入文章id參數(shù)','msg_code':-1}
  return json.dumps(ren,ensure_ascii=False)
 
#post入?yún)⒃L問方式二：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':'用戶名或密碼錯誤','msg_code':-1}
  else:
    ren = {'msg':'用戶名或密碼為空','msg_code':1001}
  return json.dumps(ren,ensure_ascii=False)
 
#post入?yún)⒃L問方式二：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':'用戶名或密碼錯誤','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') # 啟動服務(wù)
  # debug=True,改了代碼后，不用重啟，它會自動重啟
  # 'host='127.0.0.1'別IP訪問地址

運行結(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 -

請求方式：

使用postman測試接口是否可行

如：

url:127.0.0.1:8888/login

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

獲取請求參數(shù)的幾種方法：

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