iT邦幫忙

2022 iThome 鐵人賽

DAY 16
0
Modern Web

.NET教我做人系列 第 16

Day16 API神器Postman(上)

  • 分享至 

  • xImage
  •  

嗨~大家好啊,今天又是新的開始,那我們也不要浪費太多時間,我就直接進入今天的主題。那今天的話我要來說一個對開發後端的人來說非常好用的工具「Postman」

Postman 是一個可以模擬 HTTP Request 的工具,其中包含常見的 HTTP 的請求方式,例如: GET 、POST、PUT、DELETE,而他的主要功能可以用來幫我們測試API到底有沒有問題,為甚麼需要他,那是因為通常我們開發後端的工程師不太會有前端的畫面,所以就需要有像Postman的工具來先當我們的前端業面的工作

使用方式

Postman主要有兩種使用方式,分別為桌面板和Chrome版,這次的話最主要是以桌面板的方式來做說明

  • 桌面板:https://www.getpostman.com/apps
  • Chrome版:https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop?hl=zh-TW

大家下載完後可以看得的畫面應該會如下

這裡可以點上方的New來新增我們的要求,這裡我就先選HTTP Request

這裡我就先拿iT邦幫忙的官網來作例子
首先我們先選我們要的method
在把關網的連結給放在URl的欄位
送出後就可以看到官網回傳給我們的Response

Method

我們可以從Postman裡可以看到很多種method,但並不是每一我們都會用到,我們常見到的可能就GET、POST、PUT、PATCH、DELETE這幾種,其中我們最常在用POST時去設定我們的參數區

  • GET:抓取URL裡的資料
  • POST:新增一筆新的資料(如果存在會新增一筆新的)
  • PUT:更新一筆資料,如果存在這筆資就會覆蓋過去
  • PATCH:部分更新資料
  • DELETE:刪除資料

參數區介紹

區塊簡介

參數趨勢載用Postman時非常重要的地方,有時沒設定好可能就會出現錯誤,通常參數區分為三的區域,分別是 URL 網址、Header、Body,提供請求的細部設定

  • URL 網址:通常關於取得資料的篩選,都會放在這裡,可以加上兩種參數,Query Params 搜尋參數,Path Variables 路徑變數,搭配使用,做資料的篩選整理,特別注意不可以把密碼等敏感資訊放在網址
  • Header:通常關於 API 請求的標示,都會存放在這裡,例如需要身份驗證的請求,會把驗證身份的token 以 Key-Value 存在 Header (ex. Authorization: token)
  • Body:通常 API 需要提交給 Server 的資料,都會放在這裡(ex.註冊表單 name: 小明, password:1234)

Params 網址參數頁

設定 Query Params 搜尋參數 Path Variables 路徑變數

  • 預設只有 Query Params 搜尋參數,Path Variable 路徑變數,需要自行在網址上打上冒號+變數名 (ex. " : name " ),才會出現
  • 設定方式都是採 Key - value ,可以根據情況彈性勾選

Authorization 驗證設定頁

用來設定 Header 中的 Authorization 參數

這裡有抓幾種來做個說明

  • No Auth:不需要驗證
  • Basic Auth:基本身份驗證涉及在您的請求中發送經過驗證的用戶名和密碼
  • Bearer Token:Bearer 令牌使請求能夠使用訪問密鑰(例如 JSON Web 令牌 (JWT))進行身份驗證

完整介紹:https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

Header

Postman 把一些必要參數隱藏起來,如果需要特別設定,可以取消隱藏,進行修改

另外 Authorization 雖然沒有在這裡出現,不過 Authorization 驗證設定頁若有指定,還是會一起送出請求

另外我們可以在 Postman 的 Header tab 那打上 Content-type ,這裡可以要求我們要的格式類型

  • text/html : HTML格式
  • text/plain :純文本格式
  • text/xml : XML格式
  • image/gif :gif圖片格式
  • image/jpeg :jpg圖片格式
  • image/png:png圖片格式
  • application/xhtml+xml :XHTML格式
  • application/xml : XML數據格式
  • application/atom+xml :Atom XML聚合格式
  • application/json : JSON數據格式
  • application/pdf :pdf格式
  • application/msword : Word文檔格式
  • application/octet-stream : 二進制流數據(如常見的文檔下載)
  • application/x-www-form-urlencoded : <form encType="">中默認的encType,form表單數據被編碼為key/value格式發送到服務器(表單默認的提交數據的格式)
  • multipart/form-data : 需要在表單中進行文檔上傳時,就需要使用該格式

這些都是我們可以使用的類型

我們今天 Postman 的說明就先到這啦,明天會把剩下的部分補齊~我們明天見!!!


上一篇
Day15 出了問題怎麼辦
下一篇
Day17 API神器Postman(下)
系列文
.NET教我做人30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言