快捷導(dǎo)航

Python接口自動(dòng)化之文件上傳/下載接口詳解

更新時(shí)間：2022年04月05日 08:16:35 作者：IT小學(xué)生蔡坨

在接口測(cè)試中,經(jīng)常會(huì)涉及到文件上傳以及下載,下面這篇文章主要給大家介紹了關(guān)于Python接口自動(dòng)化之文件上傳/下載接口的相關(guān)資料,文中通過(guò)示例代碼介紹的非常詳細(xì),需要的朋友可以參考下

〇、前言

文件上傳/下載接口與普通接口類似，但是有細(xì)微的區(qū)別。

如果需要發(fā)送文件到服務(wù)器，例如：上傳文檔、圖片、視頻等，就需要發(fā)送二進(jìn)制數(shù)據(jù)，上傳文件一般使用的都是 Content-Type: multipart/form-data 數(shù)據(jù)類型，可以發(fā)送文件，也可以發(fā)送相關(guān)的消息體數(shù)據(jù)。

反之，文件下載就是將二進(jìn)制格式的響應(yīng)內(nèi)容存儲(chǔ)到本地，并根據(jù)需要下載的文件的格式來(lái)寫文件名，例如：F:/合同文件.pdf。

一、文件上傳接口

1. 接口文檔

Request URL： /createbyfile

Request Method： POST

Content-Type： multipart/form-data

名稱	類型	是否必須	描述
file	File	是	文檔文件
title	String	是	文檔名稱
fileType	String	是	文件類型：doc, docx, txt, pdf, png, gif, jpg, jpeg, tiff, html, rtf, xls, txt

2. 代碼實(shí)現(xiàn)

（1）實(shí)現(xiàn)步驟：

構(gòu)造文件數(shù)據(jù)，通過(guò)open函數(shù)以二進(jìn)制方式打開文件

文件上傳接口參數(shù)與普通post請(qǐng)求一樣，需要寫成Key和Value模式，Key為參數(shù)名稱file（也是組件的name屬性），Value為一個(gè)元組（與普通接口不同的地方）

"file": (
    "", # 元組第一個(gè)值為文件名稱，沒(méi)有則取None
    open(r"F:\pdf_file.pdf", "rb"), # 若第一個(gè)值非None，則取文件open打開的二進(jìn)制流，否則直接寫文件路徑，如"F:\pdf_file.pdf"
    "pdf" # 文件類型
)

"file": (
    None,
    "F:\pdf_file.pdf"
)

構(gòu)造其他數(shù)據(jù)

{
    "title": "接口發(fā)起的文檔",
    "fileType": "pdf"
}

發(fā)送請(qǐng)求，將文件數(shù)據(jù)以 files 參數(shù)傳入，其他消息體數(shù)據(jù)通過(guò) data 、json 、 headers 、 cookies 等傳入

req = {
            "url": "127.0.0.1/v2/document/createbyfile",
            "method": "POST",
            "headers": {},
            "files": {"file": ("", open(r"F:\pdf_file.pdf", "rb"), "pdf")},
            "data": {
                "title": "接口發(fā)起的文檔",
                "fileType": "pdf"
            }
        }

（2）完整代碼

base_api.py

import requests
class BaseApi:
? ? @staticmethod
? ? def requests_http(req):
? ? ? ? # ** 解包
? ? ? ? result = requests.request(**req)
? ? ? ? return result

api/createbyfile.py

# -*- coding:utf-8 -*-
# 作者：IT小學(xué)生蔡坨坨
# 時(shí)間：2022/3/12 21:04
# 功能：根據(jù)文件類型創(chuàng)建合同文檔
from base_api import BaseApi
class Createbyfile:
? ? def createbyfile(self):
? ? ? ? req = {
? ? ? ? ? ? "url": "127.0.0.1/createbyfile",
? ? ? ? ? ? "method": "POST",
? ? ? ? ? ? "headers": {},
? ? ? ? ? ? "files": {"file": ("", open(r"F:\pdf_file.pdf", "rb"), "pdf")},
? ? ? ? ? ? "data": {
? ? ? ? ? ? ? ? "title": "接口發(fā)起的文檔",
? ? ? ? ? ? ? ? "fileType": "pdf"
? ? ? ? ? ? }
? ? ? ? }
? ? ? ? res = BaseApi().requests_http(req)
? ? ? ? assert res.status_code == 200
? ? ? ? res_json = res.json()
? ? ? ? return res_json["result"]["documentId"]
if __name__ == '__main__':
? ? Createbyfile().createbyfile()

二、文件下載接口

1. 接口文檔

Request URL：/download

Request Method：GET

名稱	類型	是否必須	描述
contractId	Long	ID	ID
downloadItems	String[]	否	下載可選項(xiàng)，NORMAL(正文)，ATTACHMENT(附件)
needCompressForOneFile	Boolean	是，默認(rèn)單文件也壓縮	當(dāng)下載的文件僅一份時(shí)，是否壓縮

2. 代碼實(shí)現(xiàn)

# -*- coding:utf-8 -*-
# 作者：IT小學(xué)生蔡坨坨
# 時(shí)間：2022/4/5 2:56
# 功能：下載合同
from base_api import BaseApi
class Download:
? ? def download(self):
? ? ? ? req = {
? ? ? ? ? ? "url": "127.0.0.1/download",
? ? ? ? ? ? "method": "GET",
? ? ? ? ? ? "headers": {},
? ? ? ? ? ? "params": {
? ? ? ? ? ? ? ? "contractId": 2947403075747869536,
? ? ? ? ? ? ? ? "downloadItems": ["NORMAL"],
? ? ? ? ? ? ? ? "needCompressForOneFile": False
? ? ? ? ? ? },
? ? ? ? }
? ? ? ? res = BaseApi().requests_http(req).content # 注意“.content"獲取返回內(nèi)容
? ? ? ? # with open("F:/response.zip", "wb") as f:
? ? ? ? with open("F:/response.pdf", "wb") as f:
? ? ? ? ? ? f.write(res)
? ? ? ? return res
if __name__ == '__main__':
? ? Download().download()