本頁適用於 Apigee 和 Apigee Hybrid。
查看
Apigee Edge 說明文件。
在這個步驟中,您將執行下列步驟,將 API 發布至入口網站:
步驟 1:使用規格建立 API Proxy
使用描述 API 的 OpenAPI 規格建立 API Proxy。
如要使用 OpenAPI 規格建立 API Proxy,請按照下列步驟操作:
Cloud 控制台 UI
在 Apigee in Cloud 主控台中,依序前往「Proxy Development」>「API proxies」頁面。
點選「建立」。「Create a proxy」精靈會隨即開啟,提示您選取要建立的 API Proxy 類型。
按一下「Proxy template」方塊。
按一下「OpenAPI 規格範本,反向 Proxy (最常見)」。
在瀏覽器中開啟下列檔案,然後儲存:
https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml
在「步驟 1 OpenAPI 規格」中,點選「瀏覽」。
前往剛才下載的 OpenAPI 規格檔案,選取該檔案,然後按一下「Open」。
點選「下一步」。
在「步驟 2:Proxy 詳細資料」中,系統會使用 OpenAPI 規格的值預先填入欄位。編輯「說明」欄位,如下所示:Hello World 的 API Proxy。
點選「下一步」。
在「步驟 3 流程」中,選取所有作業。
點選「下一步」。
在「步驟 4:部署」中,選取要部署的環境。
按一下 [確定]。
按一下 [建立]。
代理程式部署完成後,「Deployments」部分的「Status」欄會顯示綠色圖示,表示已部署 API 代理程式修訂版本。將滑鼠游標懸停在狀態圖示上,即可查看部署作業的詳細資訊。
傳統版 UI
- 在 Apigee UI 中,選取左側導覽列中的「Develop」>「API proxies」,即可開啟 API proxy 頁面。
按一下「建立新項目」。
「建立 Proxy」精靈會隨即開啟,提示您選取要建立的 API Proxy 類型。
在「Reverse Proxy (most common)」下方,點選「Use OpenAPI Spec」。
系統會顯示「Use OpenAPI Spec」對話方塊。
在「網址」分頁的「OpenAPI 規格網址」欄位中,複製並貼上以下網址:
https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml
按一下「選取」。系統會開啟「Create Proxy」精靈,並使用 OpenAPI 規格的值預先填入「Proxy details」頁面。
編輯「Description」欄位,如下所示:Hello World 的 API Proxy。
點選「下一步」。
在「政策」頁面中:
- 在「安全性:授權」下方,選取「直通 (不授權)」。
- 在「安全性:瀏覽器」下方,選取「新增 CORS 標頭」。
點選「下一步」。
在「流程」頁面上,確認已選取所有作業,然後按一下「下一步」。
在「摘要」頁面上,選取「選用部署」下方的環境。
按一下「建立並部署」。
在「Summary」頁面上,您會看到系統已成功建立新的 API proxy,並部署至所選環境的確認訊息。
步驟 2:建立 API 產品
建立 API 產品,其中包含要公開給 API 使用者的 API 資源。
如何建立 API 產品:
在 Apigee in Cloud 控制台中,依序前往「Distribution」>「API products」頁面。
按一下「建立」,系統隨即會顯示「產品詳細資料」頁面。輸入 API 產品的產品詳細資料。
欄位 值 名稱 Hello World 顯示名稱 Hello World 說明 簡單的 Hello World 範例 環境 選取要部署 API Proxy 的環境。 存取 公開 自動核准存取要求 已啟用 配額 (留空) 允許的 OAuth 範圍 (留空) 在「作業」部分,按一下「新增作業」,找出要新增至 API 產品的作業。
- 在「來源」下方,選取「API proxy」,然後從下拉式選單中選取「Mock-Target-API」。
- 在「Operation」下方,在「Path」欄位中輸入正斜線 (
/
)。忽略其他欄位。
按一下「儲存」,即可儲存操作。
按一下「儲存」即可儲存產品。
步驟 3:將 API 發布至入口網站
將 API 發布至入口網站,方便客戶瞭解並使用該 API。
如要將 API 發布至入口網站,請按照下列步驟操作:
Cloud 控制台 UI
在 Apigee in Cloud 控制台中,依序前往「Distribution」>「Portals」頁面。
按一下「我的第一個入口網站」列,開啟入口網站。
按一下「API」分頁標籤。
按一下「+ API」。
在「API product」部分,選取「Hello World」。
選取「已發布 (列於目錄)」,即可將 API 發布至入口網站。
在「Display title」中輸入「Hello World」。
在「顯示圖片」部分,按一下「選取」。
按一下「素材資源」。
按一下
home-background.jpg
的「預覽」。按一下 [選取]。
如要針對 API 說明文件,從 OpenAPI 規格的快照自動產生 API 參考說明文件:
- 選取「OpenAPI 文件」。
- 按一下 [選取]。
- 按一下「網址」分頁標籤。
- helloworld。
- 複製下列網址並貼到「網址」欄位中:
https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml
- 按一下 [選取]。
按一下 [儲存]。
傳統版 UI
- 在 Apigee UI 中,前往入口網站的「API」頁面:
- 在左側導覽列中,依序選取「發布」>「入口網站」。
- 按一下「我的第一個入口網站」列,開啟入口網站。
- 按一下「API 目錄」,即可顯示「API」頁面。
- 按一下「+」。
- 在「將 API 產品新增至目錄」對話方塊中選取「Hello World」,然後按一下「下一步」。
- 在「API 詳細資料」下方,設定下列選項:
- 選取「已發布 (列於目錄)」,即可將 API 發布至入口網站。
- 如為封面圖片:
- 按一下「選取圖片」。
- 在「Select image」對話方塊中,從現有圖片清單中按一下
home-background.jpg
。 - 按一下 [選取]。
- 預覽圖片,然後按一下「選取」。
- 在「類別」中,輸入「開始使用」並按下 Enter 鍵。
將所有其他值設為預設值。
- 如要根據 OpenAPI 規格的快照,自動產生 API 參考說明文件,請在「API 說明文件」下方執行下列操作:
- 選取「OpenAPI 文件」。
- 按一下「選取文件」。
- 選取「Import from a URL」分頁標籤。
- 在「Spec name」欄位中輸入「helloworld」。
- 複製並貼到「網址」欄位中,然後按下「Enter」鍵:
https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml
- 按一下 [選取]。
- 按一下「儲存」。
步驟 4:查看 API 參考資料說明文件
如要查看 API 參考資料說明文件,請按照下列步驟操作:
- 在 Apigee UI 中,按一下「Live Portal」即可查看即時入口網站中的變更 (如果已在另一個分頁中開啟即時入口網站,請重新整理該入口網站)。
- 在直播平台中:
- 按一下頂端導覽列中的「API」,即可查看已發布的 API。
- 按一下「Hello World」資訊卡,即可查看 API 參考資料文件。
- 試試看您的 API!