APIGit
2023-04-27
在 Apigit,我們努力使 API 民主化,並使用戶能夠通過 Apigit API 平台使用和構建 API,以實現一個繁榮的 API 優先世界。我們擁有數以萬計的用戶,不斷擴大我們的影響範圍,並提供訪問 Apigit 必須提供的最佳機會的途徑——從新手到高級用戶。
要訪問下面列出的任何特定功能,您必須首先創建一個 Apigit 帳戶並登錄。可以直接從您首選的瀏覽器訪問 Apigit。
登錄後,您可以探索這五個令人興奮的功能以開始使用 Apigit。
創建 Apigit 帳戶後,您可以探索該平台的各種功能,包括創建存儲庫。存儲庫是您可以存儲代碼並與他人協作的空間。
要創建存儲庫,請導航到 Apigit 儀表板的頂部,然後單擊+
符號。從下拉菜單中選擇New repository
.在下一頁上,系統將提示您輸入存儲庫的名稱和可選描述。提供此信息後,單擊“創建存儲庫”按鈕以完成該過程。
恭喜,您已經在 Apigit 上成功創建了您的第一個存儲庫!您現在可以開始添加文件、與他人協作以及利用該平台的許多其他功能。
第一步:創建存儲庫
要將 API 規範添加到您的 Apigit 儀表板,請單擊+
標誌位於左上角。輸入路徑名,例如test/myfirst.json
,以及其他相關信息,例如title
和version
.
在添加新的 API 規範之前,您可能想要瀏覽存儲庫中提供的示例。通過單擊左側邊欄中的 🪄 圖標,您可以切換到不同的查看器。例如,您可以選擇petstore-json-format.json
文件來自examples
文件夾並將查看器切換到code
查看示例規範的 JSON 格式代碼。
要編輯您的 API 規範,請將鼠標懸停在文件上並單擊⋮
文件末尾的圖標或單擊儀表板左下角的✏️圖標。然後您可以從示例中復制 JSON 代碼並使用它來創建您自己的規範。這是您的第一個 API 規範的示例。
第二步:添加 api spec
模擬服務器通常用於 API 開發,以在 API 完全實現之前模擬 API 的行為。開發人員可以使用模擬服務器來測試他們的代碼並確保它按預期工作,而無需等待 API 完成或必須向真實服務器發出請求。
在 Apigit 中部署模擬服務器是一個簡單的過程。首先,導航到您的存儲庫並單擊Mock Server Script
按鈕。完成服務器腳本後,發布服務器。然後,您可以在Mock Servers
位於頂部菜單中的頁面。
第三步:創建並發布模擬服務器
API 測試是驗證 API 是否符合其規範,是否可以處理不同類型的輸入和輸出,以及是否優雅地處理錯誤和異常的過程。 API 測試可以手動進行,也可以使用模擬對 API 的請求和響應的自動化工具進行。
要在 Apigit 上開始 API 測試,請單擊Test Cases
位於存儲庫下方的按鈕。在這裡,您將找到 API 測試示例。創建自己的測試用例並替換baseurl
使用在步驟 3 中生成的模擬服務器 URL。
發布 API 測試用例後,您可以在API Testing
頁。您可以通過單擊API Testing
頂部菜單中的按鈕。
第四步:創建並發布API Testing
Apigit 是一個流行的 API 協作平台,可以輕鬆共享工作。無論您是與一個朋友一起從事小型項目,還是擁有數百名開發人員積極開發公共 API 的企業公司的一部分,您都可以控制可見的內容以及對誰可見。
如果您創建了您認為世界應該看到的東西,您可以將其發佈到 Apigit API 網絡。這將允許全球的 Apigit 用戶訪問您的收藏。
現在您已經掌握了一些基礎知識,請花一些時間在 Apigit 上探索和發現更多有用的功能。例如,您是否知道可以設計一個依賴於另一個 API 結果的 API 測試用例?探索此工具以及平台上提供的許多其他有用工具。