OpenAPI Mock Api 工具試用心得

malagege included in OpenAPI

2023-01-09 139 words One minute

https://user-images.githubusercontent.com/6058558/211311191-50b8e286-5f86-4896-a851-f3e539e9c41c.png

Contents

最近研究 OpenAPI Spec 都還沒試試 Mock Api工具，這邊測試 Mockoon和prism，簡單做個心得。

Mockoon

因為我現在有在 Window Server 開發，所以想找個 Window 可以直接使用的。首先我看到這個小試了一下，順便紀錄。

下載與安裝

官網 Github 下載方法連結這邊可以參照官網指令做下載

官網 Github Release 也有免安裝檔可以執行。Release API Sprout 1.3.0 · danielgtaylor/apisprout

試用心得

有免安裝版真的是太方便了，這邊是用免安裝去執行的。這邊有不小心載到setup安裝，預設是一鍵安裝。也可以考慮看看。

這邊可以準備自己的 OAS 的文件。沒有的話可以用TDX OAS，連結在這邊。API OAS文本 :請點我可下載 OAS 的 JSON 文件。

參考下圖匯入 TDX.json

會跳出叫你另存環境檔。

相關回傳 JSON 訊息還可以自己定義。透過 faker 可以顯示多筆資料，請參考官網Create dynamic responses with templating。

相關注意設定:

Automatic handling of CORS preflight OPTIONS requests

算是功能還滿多的工具。但我發現他不會檢查 Request 參數/Header相關東西，用 prism 會檢查參數。我覺得可以因應需求調整。

prism(推薦)

直接試打一隻 API 測試，用瀏覽器會看到 http://127.0.0.1:4010/v2/Bus/RealTimeByFrequency/Streaming/City/test結果 {"type":"https://stoplight.io/prism/errors#UNAUTHORIZED","title":"Invalid security scheme used","status":401,"detail":"Your request does not fullfil the security requirements and no HTTP unauthorized response was found in the spec, so Prism is generating this error for you.","headers":{"WWW-Authenticate":"OAuth2"}}。這邊推薦用 POSTMAN 測試會比較好用。

一樣也有 Window 執行檔案。指令一行解決，這邊發現近幾天還有更新，看來用這個應該還滿穩的。

1
2
3


#window 
prism-cli-win mock tdx.json
prism-cli-win  mock https://raw.githack.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml