從一個 JSON 對象開始

以下是一個簡單的 JSON 對象示例：

{
  "slug": "json-to-working-api-in-seconds",
  "title": "Using AI to Go From JSON to API in Seconds"
}

雖然這個對象看起來簡單，但在實際開發中，我們需要構建一個服務來實現對資源的增刪改查操作（RESTful API 還需要為子資源（如與文章相關的社交帖子）創建一組端點。

為了簡化這一過程，我開發了一個端點，它能夠遞歸檢查 JSON 對象中的子實體，識別潛在的端點，并生成 API 規范。這個過程利用了 Amazon Bedrock 和生成式人工智能（GenAI）的強大功能，使得 API 規范的生成變得更加高效。

通過這種方法，我們可以快速獲得一個完整的 API 規范，供前端開發人員使用。

更進一步：從規范到模擬服務器

生成 API 規范只是第一步。為了讓前端開發人員能夠快速測試和開發，我們需要一個模擬服務器來返回模擬數據。Postman 提供了模擬服務器功能，可以根據 API 規范自動生成模擬端點。

以下是創建模擬服務器的工作流程：

1. 調用 API 規范生成器生成規范。
2. 使用 Postman API 創建 API、集合和模擬服務器。
3. 更新 API 規范以包含模擬服務器的 URL。

通過這種方式，前端開發人員可以直接調用模擬端點，快速驗證和開發用戶界面。

使用 Postman 收藏

以下是從 JSON 對象到功能性模擬服務器的具體步驟。

一次性設置

1. 將規范生成堆棧部署到 AWS 賬戶中。
2. 復制部署輸出中的 GenerateSpecEndpoint 值。
3. 將 API 快速啟動集合導入到 Postman 工作區。
4. 創建 Postman API 密鑰。
5. 在 Postman 中創建一個環境，添加名為 Postman_API_KEY 的變量，并將生成的密鑰粘貼到其中。
6. 更新集合中的 GENERATOR_BASE_URL 變量，使用步驟 2 中的值。
7. 更新集合中的 workspaceId 變量，使用工作區的標識符。

生成新的 API

完成初始設置后，創建 API 的流程如下：

1. 創建或復制一個 JSON 對象。
2. 替換 Generate Spec 請求的 Body 中的 example 屬性值。
3. 替換 resourceName 屬性值為 API 的名稱。
4. 點擊收藏并運行。
5. 在運行屏幕中點擊 運行 API 快速啟動 按鈕。

運行完成后，您可以在 Postman 中查看生成的 API 規范，并獲取模擬服務器的 URL。

示例運行

以下是一個示例運行的結果展示：

通過這種方式，前端開發人員只需一個 JSON 對象即可開始使用模擬端點進行開發。

從這里到未來

這一概念驗證展示了如何利用人工智能快速生成 API 規范和模擬服務器。雖然目前的實現已經足夠強大，但未來可以進一步優化，例如：

• 使用更強大的 AI 模型（如 GPT-4 Turbo）生成更復雜的規范。
• 自動生成 SDK，以便開發人員更方便地與后端服務交互。
• 創建一個集成化的網頁工具，讓用戶可以在一個界面中完成所有操作。

通過這些改進，我們可以進一步提升開發效率，讓開發人員專注于更高價值的工作。

試試看

希望本文介紹的工具和方法對您有所幫助。通過這種方式，您可以更快地進入 API 優先的開發周期，提升前端開發的效率。

如今，生成式人工智能正在改變軟件開發的方式。通過利用這些工具，我們可以節省時間，提高生產力，并推動 API 開發實踐的進步。

如果您對本文提到的工具感興趣，可以在 GitHub 上找到生成器代碼，或者訪問我的 Postman 公共工作區。如果需要幫助，請隨時聯系我！

編碼愉快！

原文鏈接: https://www.readysetcloud.io/blog/allen.helton/json-to-working-api-in-seconds/