《開源精選》是我們分享Github、Gitee等開源社區中優質項目的欄目,包括技術、學習、實用與各種有趣的內容。本期推薦的Hoppscotch是一個開源的API 開發生態系統。
Hoppscotch特徵
輕量級:採用簡約的 UI 設計精製而成。
快速:實時發送請求和獲取/複製響應。
HTTP 方法
- GET- 請求檢索資源信息
- POST- 伺服器在資料庫中創建一個新條目
- PUT- 更新現有資源
- PATCH- 非常類似於PUT但對資源進行部分更新
- DELETE- 刪除資源或相關組件
- HEAD- 檢索與 GET 請求相同的響應標頭,但沒有響應正文。
- CONNECT- 建立到目標資源標識的伺服器的隧道
- OPTIONS- 描述目標資源的通信選項
- TRACE- 沿著到目標資源的路徑執行消息環回測試
- <custom>- 一些 API 使用自定義請求方法,例如LIST. 輸入您的自定義方法。
主題化
- 選擇主題:系統(默認)、淺色、深色和黑色
- 選擇強調色:綠色(默認)、藍綠色、藍色、靛藍、紫色、黃色、橙色、紅色和粉色
- 無干擾的禪宗模式
自定義主題與雲/本地會話同步
PWA:在您的設備上安裝為PWA 。
- 使用 Service Worker 即時加載
- 離線支持
- 低 RAM/內存和 CPU 使用率
- 添加到主屏幕
- 桌面 PWA
請求:立即從端點檢索響應。
- 選擇method
- 進入URL
- 發送
- 複製/共享公共「共享 URL」
- 為 10 多種語言和框架生成/複製請求代碼片段
- 進口cURL
- 標籤請求
WebSocket:通過單個 TCP 連接建立全雙工通信通道。
伺服器發送的事件:通過 HTTP 連接從伺服器接收更新流,而不訴諸輪詢。
Socket.IO:使用 SocketIO 伺服器發送和接收數據。
MQTT:訂閱和發布到 MQTT 代理的主題。
GraphQL: GraphQL 是一種用於 API 的查詢語言,也是一種使用現有數據完成這些查詢的運行時。
- 設置端點並獲取架構
- 多欄文檔
- 設置自定義請求標頭
- 查詢架構
- 獲取查詢響應
授權:允許識別最終用戶。
- 沒有任何
- 基本的
- 不記名令牌
- OAuth 2.0
- OIDC 訪問令牌/PKCE
標頭:描述發送請求正文的格式。
參數:使用請求參數來設置模擬請求中的不同部分。
請求正文:用於通過 REST API 發送和接收數據。
- 放Content Type
- FormData、JSON 等
- 在鍵值和 RAW 輸入參數列表之間切換
響應:包含狀態行、標題和消息/響應正文。
- 將響應複製到剪貼板
- 將響應下載為文件
- 查看響應標頭
- 查看 HTML、圖像、JSON、XML 響應的原始和預覽
歷史記錄:請求條目與雲/本地會話存儲同步,只需單擊即可恢復。
集合:使用集合和文件夾組織您的 API 請求。只需單擊一下即可重複使用它們。
- 無限的收藏、文件夾和請求
- 嵌套文件夾
- 作為文件或 GitHub gist 導出和導入
集合與雲/本地會話存儲同步
代理:從設置中啟用代理模式以訪問被阻止的 API。
- 隱藏您的 IP 地址
- 修復CORS(跨域資源共享)問題
- 訪問在非 HTTPS ( http://) 端點中提供的 API
- 使用您的代理 URL
快速入門指南
Hoppscotch UI 由以下組件組成:
- 頂部欄允許您查看我們的存儲庫,使用您的帳戶登錄並提供有用的連結。
- 左側邊欄提供對可用於 Web 開發的工具套件的訪問。
- 您可以在右下角更改您的首選語言。
REST API 平台
- 中心區域是您構建和處理 API 請求的地方。
- 在分隔線下方的左側邊欄中是圖標,可將您引導至請求、選項和響應的特定窗格。
- 右側面板允許您查看最近的 API 請求歷史、集合和環境。
歷史
顯示您最近發出的 API 請求,讓您從離開的地方重新開始。
收藏
Hoppscotch 允許您使用集合和文件夾來組織 API 請求。
環境
在您的請求和腳本中存儲變量和重用值 要設置環境,請從可用環境的下拉列表中進行選擇。
GraphQL 編輯器
- 中心區域是您使用 graphql 查詢的地方。
- 在分隔線下方的左側邊欄中是圖標,可將您引導至 Schema、Query 和 Response 的特定窗格。
- 右側面板包含用於模式文檔、查詢、歷史記錄和集合的選項卡。為方便起見,可以隱藏此面板。
API 文檔生成器
您可以導入集合。或者從右側面板中選擇您在 Hoppscotch 中製作的現有收藏。單擊生成文檔以獲取 API 文檔。
攔截器和附加組件
使用 proxyscotch/自定義中間件或 Hoppscotch Web 擴展訪問被 CORS 限制阻止的 API。
使用代理
在設置中啟用代理。
ProxyScotch 的工作原理
使用自定義中間件
由於CORS就像添加一些 HTTP 標頭一樣簡單,並且它是唯一被阻止的瀏覽器,因此您可以構建一些類似代理的組件,它基本上會為您進行調用,從所需的 API 獲取響應,將這些標頭添加到頂部,然後把它寄回跳房子。
使用 Hoppscotch 網絡擴展
- 在此處下載 Hoppscotch 瀏覽器擴展程序。
- 在設置中啟用它。
- 打開擴展並添加新的來源
Hoppscotch 擴展將所有添加的來源路由到代理。
API 文檔
隨時隨地為您的 API 生成文檔。使用集合中的 API 或導入本地集合併獲取 API 文檔作為gist可在協作者之間共享的秘密。
—END—
開源協議:MIT license
開源地址:https://github.com/hoppscotch/hoppscotch