步驟 6：發布 API

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊

在這個步驟中，您將執行下列步驟，將 API 發布到入口網站：
1. 建立 OpenAPI 規格
2. 根據規格建立 API Proxy
3. 建立 API 產品
4. 將 API 發布至入口網站

步驟 1：建立 OpenAPI 規格

每項 OpenAPI 規格在 API 生命週期中都是可靠資料來源。API 生命週期的各個階段 (從開發到發布) 都會採用相同的規格。

如何建立 OpenAPI 規範：

1. 在左側導覽列中，依序選取「Develop」(開發) >「Specs」(規格)，即可開啟「Specs」(規格) 頁面。
2. 依序按一下「+ 規格」>「匯入網址」。
3. 在匯入對話方塊中輸入下列資訊：
4. 匯入名稱：helloworld

5. 匯入網址：https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml

6. 按一下「Import」。

步驟 2：透過規格建立 API Proxy

透過說明 API 的 OpenAPI 規格建立 API Proxy。

如何透過 OpenAPI 規範建立 API Proxy：

1. 在「Specs」頁面中，將遊標移到 helloworld 規格上，即可顯示動作選單。
2. 按一下 以根據規格產生 API Proxy。
   「建構 Proxy」精靈開啟後，「詳細資料」頁面會預先填入 OpenAPI 規範的值。
3. 按照下列方式編輯「Description」欄位：Hello world for hello world。
4. 點選「下一步」。

5. 在「政策」頁面上：

   • 在「安全性：授權」下方，選取「通過 (無授權)」。
   • 在「安全性：瀏覽器」下方，選取「新增 CORS 標頭」。

   

6. 點選「下一步」。

7. 在「Flows」頁面中，確認已選取所有作業，然後點選「Next」。
   

8. 在「Virtual Hosts」頁面中，確認已選取所有虛擬主機，然後按一下「Next」。

9. 在「Summary」頁面的「Optional Deployment」下方，選取要部署的環境。

   

10. 按一下「Create」(建立)。

「Summary」頁面會顯示確認訊息，說明新的 API Proxy 已成功建立並部署至測試環境。

步驟 3：建立 API 產品

建立一個 API 產品，其中包含您要向 API 消費者公開的 API 資源。

如何建立 API 產品：

1. 在左側導覽列中，依序選取「Publish」(發布) >「API Products」(API 產品)，即可開啟「API 產品」頁面。
2. 按一下「+ API 產品」。
   畫面上會顯示「新增產品」頁面。
3. 輸入 API 產品的「Product Details」。
   注意：根據預設，您發布 API 產品時，入口網站會顯示「Display Name」(顯示名稱) 和「Description」欄位。如要編輯值，請參閱「步驟 4：將 API 發布至您的入口網站」。
   

   欄位	值
   名稱	Hello World
   顯示名稱	Hello World
   說明	簡易的 Hello World 範例
   環境	請選取要部署 API Proxy 的環境。
   存取權	公開
   自動核准存取要求	已啟用
   配額	(留白)
   允許的 OAuth 範圍	(留白)

4. 在「API 資源」下方點選「新增 Proxy」，找出要新增至 API 產品的 API Proxy。
   系統隨即會顯示「Add API Resource」對話方塊。
5. 按一下「API Proxy」 (如果尚未選取)，然後在清單中選取「Mock-Target-API」。
6. 按一下「Add」(新增)。
7. 按一下「儲存」來儲存 API 產品。

   

步驟 4：將 API 發布至入口網站

將 API 發布至入口網站，讓客戶瞭解及使用 API。

如何將 API 發布到入口網站：

1. 前往入口網站的「API」頁面：
   1. 在左側導覽列中，依序選取「發布」>「入口網站」。
   2. 按一下「My first Portalal」列，即可開啟入口網站。
   3. 按一下「API Catalog」，顯示 API 頁面。
2. 按一下「+」+。
3. 在「將 API 產品新增至目錄」對話方塊中選取「Hello World」，然後按一下「Next」。
4. 在「API 詳細資料」下方，設定下列選項：
   • 選取「已發布 (列於目錄中)」，將 API 發布至入口網站。
   • 如果是「多媒體圖片」：
     1. 按一下「選取圖片」。
     2. 在「選取圖片」home-background.jpg對話方塊中的現有圖片清單中，按一下「home-background.jpg」home-background.jpg。
     3. 按一下「選取」。
     4. 預覽圖片，然後按一下「選取」。
   • 在「類別」部分輸入「開始使用」，然後按下 Enter 鍵。

   其他設定均保留預設值。

5. 在「API 說明文件」下方，如要透過 OpenAPI 規範的快照自動產生 API 參考說明文件：
   1. 選取「OpenAPI 文件」。
   2. 按一下「選取文件」。
   3. 選取「My Specs」分頁標籤 (如果尚未選取)。
   4. 從規格清單中選取「helloworld」helloworld。
   5. 按一下「選取」。
6. 按一下「儲存」，儲存 API 詳細資料。

   

如要查看 API 參考說明文件：

1. 按一下「Live Portal」前往即時入口網站查看所做的變更。或者，如果入口網站已在其他分頁中開啟，也可以重新整理入口網站。
2. 按一下頂端導覽列中的「API」，查看已發布的 API。
3. 按一下「Hello World」資訊卡，查看 API 參考說明文件。立即試用您的 API！

---

恭喜！您已成功完成教學課程。想瞭解更多資訊嗎？ 前往建構整合式入口網站。