

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# API Gateway 中的入口網站產品
<a name="apigateway-portals-portal-product"></a>

*入口網站產品*代表您要共用的服務或功能。您的入口網站產品是產品 REST 端點和產品頁面的集合。*產品 REST 端點*是入口網站產品的存取點，由 REST API 的路徑和方法及其部署的階段組成。*產品頁面*是您用來說明 API 消費者如何使用您產品端點的文件。入口網站產品可以包含整個`Prod`階段做為產品 REST 端點的集合，或僅包含部署到`Prod`階段`GET /pets`的資源做為單一產品 REST 端點。

您的入口網站產品可自訂。您可以新增自訂文件、重新命名產品 REST 端點、重組顯示順序、新增區段，以及跨 AWS 帳戶共用產品。若要讓入口網站產品的任何變更生效，您必須重新發佈使用入口網站產品的任何入口網站。

## 寵物採用入口網站產品範例
<a name="apigateway-portals-portal-product-example"></a>

例如，您可以擁有多個代表寵物採用服務的 REST APIs。您可以使用 API Gateway 來建立`pet adoption`入口網站產品。此入口網站產品將協助客戶探索他們應該使用哪些 APIs 來滿足和採用寵物。此入口網站產品使用您已建立的 REST APIs，但可讓您重新分組和組織它們。您也可以提供使用寵物採用入口網站產品的條款與條件文件，讓客戶試用您的 APIs。此資訊全部存放在您的入口網站產品中。

下表顯示代表寵物採用入口網站產品的三個 APIs，及其對應的產品 REST 端點操作名稱和頁面區段名稱。


| REST API ID | REST API 路徑和方法 | REST API 階段 | 操作名稱 | 頁面區段 | 
| --- | --- | --- | --- | --- | 
| kf5387miad |  GET /dogs  | 生產 |  View dogs  |  AdoptAnimals  | 
| kf5387miad  | GET /dogs/\$1dogId\$1  | 生產 | View dog  | AdoptAnimals  | 
| ra8obxcevg  | GET /cats  | 生產 | View cats  | AdoptAnimals  | 
| ra8obxcevg  | GET /cats/\$1catId\$1  | 生產 | View cat  | AdoptAnimals  | 
| h0rpx9cm62  |  ANY /user/\$1userId\$1/\$1petId\$1\$1  | 試用版 | Request visit  | AdoptProcess  | 

在此範例中，兩個 REST APIs `ra8obxcevg`和 `kf5387miad`會在 `AdoptAnimals`區段中分組在一起。此排序導覽的結果在入口網站中會如下所示：

![\[寵物採用入口網站\]](http://docs.aws.amazon.com/zh_tw/apigateway/latest/developerguide/images/apigateway-portal.png)


由於 `ANY`方法是全部截獲方法，入口網站會顯示所有支援的 HTTP 方法。此入口網站也包含入口網站產品擁有者建立的文件。

## 後續步驟
<a name="apigateway-portals-portal-product-next-steps"></a>

若要開始使用入口網站產品，您可以執行下列動作：
+ 若要建立入口網站產品，請參閱 [在 API Gateway 中建立入口網站產品](apigateway-portals-create-portal-product.md)。
+ 若要了解 try it 功能，請參閱 [針對入口網站中的 API Gateway 產品 REST 端點啟用試用](apigateway-portals-try-it.md)。
+ 若要了解產品頁面，請參閱 [在 API Gateway 中建立產品頁面](apigateway-portals-create-product-page.md)。
+ 若要了解如何共用入口網站產品，請參閱 [在 API Gateway 中共用入口網站產品](apigateway-portals-share-resources.md)。

建立入口網站產品後，您可以將其發佈至入口網站。如需詳細資訊，請參閱[在 API Gateway 中建立入口網站](apigateway-portals-create-portal.md)。

# 在 API Gateway 中建立入口網站產品
<a name="apigateway-portals-create-portal-product"></a>

下列程序說明如何建立入口網站產品。入口網站是*入口網站產品的*集合。建立入口網站產品後，您可以建立產品 REST 端點和產品頁面。若要了解入口網站產品，請參閱 [API Gateway 中的入口網站產品](apigateway-portals-portal-product.md)。

## 考量事項
<a name="apigateway-portals-portal-product-considerations"></a>

下列考量可能會影響您建立入口網站產品的方式：
+ 您的入口網站產品可以同時包含私有和公有 REST APIs。試用功能不支援私有 APIs，因此在入口網站中具有視覺化差異。身為入口網站擁有者，您可能需要提供說明的文件。
+ 如果您使用 AWS CLI AWS SDKs建立入口網站產品，您的入口網站將不會有任何產品端點或產品頁面。您需要使用 AWS CLI 或 主控台新增這些資源。若要了解如何建立產品 REST 端點，請參閱 [在 API Gateway 中建立產品 REST 端點](apigateway-portals-create-product-rest-endpoint.md)。若要了解如何建立產品頁面，請參閱 [在 API Gateway 中建立產品頁面](apigateway-portals-create-product-page.md)。

## 建立入口網站產品
<a name="apigateway-portals-portal-product-create"></a>

下列程序說明如何建立入口網站產品。

**建立入口網站產品**

1. 在以下網址登入 API Gateway 主控台：[https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway)。

1. 在主導覽窗格中，選擇**入口網站產品**。

1. 選擇**建立產品**。

1. 在**產品名稱**中，輸入入口網站產品的名稱。

1. 針對**產品描述**，輸入描述。

1. 選擇**下一步**。

1. 若要選取您的產品 REST 端點，請在 **API 端點**下選擇 API，然後選擇階段。

1. 若要將端點新增至您的產品 REST 端點，請選取 API 端點，然後選擇**新增至產品**。
**注意**  
在未先選擇**新增至產品**的情況下，請勿選擇**下一步**。  

![\[入口網站產品\]](http://docs.aws.amazon.com/zh_tw/apigateway/latest/developerguide/images/apigateway-portal-product.png)


   API 端點會出現在**選取的 API 端點**清單中。

1. 選擇**下一步**。

1. 檢閱您的選擇，然後選擇**建立產品**。

使用主控台建立入口網站產品後，所有產品頁面和產品 REST 端點頁面都是草稿，不會出現在入口網站中。若要讓消費者看到您的產品頁面和產品 REST 端點頁面，您需要將草稿新增至區段。如果您使用 AWS CLI 或 AWS SDKs 建立入口網站產品，請將草稿新增至 AWS CLI 命令中的 區段。無論您如何將草稿新增至區段，都必須發佈使用入口網站產品的入口網站，消費者才能看見它。

**將草稿新增至頁面區段**

1. 您的草稿會列在**文件**索引標籤中。您的產品**頁面有草稿文件**頁面，產品 REST 端點**頁面有草稿 API 參考**頁面。選擇**草稿 API 參考頁面**。

1. 選擇草稿 API 參考頁面。

   如果您沒有任何產品 REST 端點，則不會有任何 API 參考頁面草稿。若要了解如何建立產品 REST 端點，請參閱 [在 API Gateway 中建立產品 REST 端點](apigateway-portals-create-product-rest-endpoint.md)。

1. 選擇**編輯頁面**。

1. 在此頁面上，您可以覆寫任何現有的 API 文件組件，或使用 API Gateway 文件。若要允許消費者看到產品 REST 端點頁面的內容，請在**區段名稱**下輸入名稱。如果這是`/pets-GET`端點，則頁面名稱可能是 `Pets`。

1. 選擇**儲存變更**。

1. 您建立的新頁面名稱會顯示在 **API 參考頁面**區段下方。

   若要允許消費者看見新頁面，您仍然需要重新發佈入口網站。如需詳細資訊，請參閱[在 API Gateway 中發佈入口網站](apigateway-portals-publish-portal.md)。

# 在 API Gateway 中建立產品 REST 端點
<a name="apigateway-portals-create-product-rest-endpoint"></a>

產品 REST 端點是您入口網站產品的存取點。每個端點都包含 REST API 的路徑和方法，以及其部署所在的階段。端點包含您為 REST API 定義的任何文件，也可以使用自訂文件進行更新。當您建立產品 REST 端點時，您可以設定下列設定：
+ 產品 REST 端點的操作名稱。如果您的 REST API 具有路徑和方法 `GET /pets`，在入口網站中，名稱為 `/pets`。您可以使用 操作名稱，將產品 REST 端點名稱變更為 `Pet summaries`。這不會影響您現有的 API。
+ 適用於您產品端點的 try it 功能。這可讓 API 消費者在您的APIs。如果您為私有 API 建立產品端點，則 try it 功能會設為 `UNAVAILABLE`。如需詳細資訊，請參閱[針對入口網站中的 API Gateway 產品 REST 端點啟用試用](apigateway-portals-try-it.md)。
+ 如果您目前有為 REST API 定義的文件組件，您可以匯入文件或覆寫現有的文件，並使用 [GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) 建立新的產品層級文件。任何文件覆寫都不會傳播回您的 API Gateway API 文件組件。如果您匯入目前的文件組件，API Gateway 會跨 API 同步變更至您的產品 REST 端點。

## 建立產品 REST 端點
<a name="apigateway-portals-create-product-rest-endpoint-create"></a>

下列程序說明如何將產品 REST 端點新增至現有的入口網站產品。若要了解如何同時建立入口網站產品和產品 REST 端點，請參閱 [在 API Gateway 中建立入口網站產品](apigateway-portals-create-portal-product.md)。

**為產品入口網站建立產品 REST 端點**

1. 在以下網址登入 API Gateway 主控台：[https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway)。

1. 在主導覽窗格中，選擇**入口網站產品**。

1. 選擇入口網站產品。

1. 選擇**關聯的端點**索引標籤，然後選擇**新增端點**。

1. 若要選取您的產品 REST 端點，請在 **API 端點**下選擇 API，然後選擇階段。

1. 若要將端點新增至您的產品 REST 端點，請選取 API 端點，然後選擇**新增至產品**。

   API 端點會出現在**選取的 API 端點**清單中。

1. 選擇**提交**。

1. 您的產品 REST 端點頁面現在是草稿。選擇**草稿 API 參考頁面**，然後選擇您的產品 REST 端點頁面，以完成頁面的內容。

1. 選擇**編輯頁面**。

1. 若要覆寫現有的 API Gateway 文件，請針對**文件來源**開啟**覆寫文件**並執行下列動作：

   1. 針對**顯示內容**，選擇**建立覆寫**。

   1. 針對**操作名稱**，輸入新的操作名稱。

   1. 在**頁面內文**中，輸入您的自訂文件。

   1. （選用） 針對**端點**，輸入入口網站中顯示的自訂端點。

1. 若要讓客戶在您的入口網站中叫用您的 API，請選取**試用功能**。如需詳細資訊，請參閱[針對入口網站中的 API Gateway 產品 REST 端點啟用試用](apigateway-portals-try-it.md)。

1. 針對**區段名稱**，輸入名稱或選擇現有區段。當您將產品 REST 端點新增至區段時，消費者可以在已發佈的入口網站上檢視您的內容。

1. 選擇**儲存變更**。

若要允許消費者看到新頁面，您仍然需要重新發佈入口網站。如需詳細資訊，請參閱[在 API Gateway 中發佈入口網站](apigateway-portals-publish-portal.md)。

# 在 API Gateway 中建立產品頁面
<a name="apigateway-portals-create-product-page"></a>

產品頁面可協助您的產品消費者了解和使用您的產品。文件位於產品層級，因此包含您產品的任何入口網站都有此文件。API Gateway 支援兩種以 [GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) 撰寫的產品頁面類型：

概觀頁面  
當您建立產品時，API Gateway 會根據您在建立產品時提供的資訊，自動為您的產品產生**概觀**頁面。此頁面具有無法變更的其他格式。您可以修改文字或從入口網站產品中移除頁面。

自訂頁面  
自訂頁面是以 Markdown 撰寫的頁面。您可以針對條款與條件或如何使用產品的教學使用本節。您可以將任何自訂頁面變更為概觀頁面。當您將自訂頁面變更為概觀頁面時，頁面內容會格式化為符合概觀頁面。

## 考量事項
<a name="apigateway-portals-create-product-page-considerations"></a>

下列考量事項可能會影響您使用產品頁面：
+ 本文件不在 API 層級，且不包含任何方法、資源或任何請求參數。若要了解如何修改產品 API 層級的文件，請參閱 [在 API Gateway 中更新產品 REST 端點](apigateway-portals-update-product-endpoint.md)。
+ 您無法將`.md`檔案直接上傳至您的產品。
+ 您可以修改入口網站產品的顯示順序，來修改產品頁面的順序。如需詳細資訊，請參閱[在 API Gateway 中更新入口網站產品](apigateway-portals-update-portal-product.md)。
+ 您需要重新發佈包含您產品的任何入口網站，文件變更才會生效。
+ 如果您有多個入口網站使用相同的入口網站產品，則所有入口網站的產品頁面都相同。若要擁有相同的產品 REST 端點，但擁有不同的產品頁面，請建立多個產品。

## 建立產品頁面
<a name="apigateway-portals-create-product-page-create"></a>

下列程序說明如何建立產品頁面。

**建立產品頁面**

1. 在以下網址登入 API Gateway 主控台：[https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway)。

1. 在主導覽窗格中，選擇**入口網站產品**。

1. 選擇產品。

1. 在**文件**下，選擇**建立自訂頁面**。

1. 針對**頁面標題**，輸入頁面標題。

1. 針對**內文**，使用 GitHub Flavored Markdown 輸入您的補充文件。

   **預覽**區段顯示您的內容在入口網站中的顯示方式。最終視覺效果樣式可能會根據您的入口網站設定而變更。

1. 選擇**建立產品頁面**。

1. 您的產品頁面現在是草稿。選擇**草稿文件頁面**，然後選擇您的產品頁面以完成頁面的內容。

1. 選擇**編輯頁面**。

1. 針對**區段名稱**，輸入名稱或選擇現有區段。當您將產品頁面新增至區段時，消費者可以在已發佈的入口網站上檢視您的內容。

1. 選擇**儲存變更**。

若要允許消費者看見新頁面，您仍然需要重新發佈入口網站。如需詳細資訊，請參閱[在 API Gateway 中發佈入口網站](apigateway-portals-publish-portal.md)。

# 在 API Gateway 中更新入口網站產品
<a name="apigateway-portals-update-portal-product"></a>

當您更新入口網站產品時，您可以變更產品 REST 端點和產品頁面顯示方式的名稱、描述或顯示順序。若要修改顯示順序，您可以修改產品頁面的頁面清單，以及產品端點的區段名稱。如果您使用 AWS CLI 或 SDKs 執行此操作，您可以指定產品頁面 ARN 或產品 REST 端點 ARN。您需要為 API 消費者重新發佈任何使用您的 產品的入口網站，以查看入口網站中反映的變更。

## 更新入口網站產品
<a name="apigateway-portals-update-portal-product-update"></a>

下列程序說明如何變更區段清單以重新排序產品 REST 端點，因為它們將出現在入口網站中。在此程序中，我們假設您在入口網站產品中至少有兩個產品 REST 端點。

**更新入口網站產品**

1. 在以下網址登入 API Gateway 主控台：[https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway)。

1. 在主導覽窗格中，選擇**入口網站產品**。

1. 選擇產品。

1. 在**文件**索引標籤中，針對**產品頁面**，選擇**管理**。

1. 拖放產品 REST 端點以重新排序。您也可以將產品 REST 端點和產品頁面移至草稿頁面區段。草稿頁面中的頁面不會出現在您的入口網站中。

1. （選用） 重新命名產品 REST 端點名稱或新增新的 API 參考區段。這些變更不會影響您APIs。

1. 選擇**儲存變更**。

# 在 API Gateway 中更新產品 REST 端點
<a name="apigateway-portals-update-product-endpoint"></a>

當您更新產品 REST 端點時，您可以變更產品端點的所有設定，但 REST API 的路徑和方法及其部署的階段除外。產品端點的任何變更都會自動更新，但您需要重新發佈使用您的產品的任何入口網站，以查看入口網站中反映的變更。

## 更新產品 REST 端點
<a name="apigateway-portals-update-product-endpoint-update"></a>

下列程序說明如何更新產品 REST 端點，以使用自訂 API 參考文件覆寫目前的 API 文件。

**更新產品 REST 端點**

1. 在以下網址登入 API Gateway 主控台：[https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway)。

1. 在主導覽窗格中，選擇**入口網站產品**。

1. 選擇產品。

1. 在**文件**索引標籤的 **API 參考頁面**下，選擇產品 REST 端點的名稱，例如 **/dogs - GET**。

1. 針對**預覽**，選擇**編輯頁面**。

1. 針對**文件來源**，開啟**覆寫文件**。

1. 針對**顯示內容**，選擇**覆寫現有內容**。

   如果您選擇**移除所有內容**，則會從頁面中移除內容，但您可以選擇**覆寫現有內容**以再次存取文件。

1. 在**頁面內文**中，使用 [GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) 輸入自訂 API 參考文件。

   本文件不會傳播回 API Gateway。

1. 選擇**儲存變更**。

1. 您必須重新發佈任何使用此入口網站產品的入口網站，變更才會生效。

# 在 API Gateway 中更新產品頁面
<a name="apigateway-portals-update-product-page"></a>

當您更新產品頁面時，您可以變更產品頁面的所有設定。產品頁面的任何變更都會自動更新，但您需要重新發佈使用您的產品的任何入口網站，以查看入口網站中反映的變更。

# 在 API Gateway 中共用入口網站產品
<a name="apigateway-portals-share-resources"></a>

您可以在 AWS 帳戶 使用 之間共用入口網站產品 AWS RAM。當您共用入口網站產品時，另一個帳戶可以在自己的入口網站中使用入口網站產品。透過共用入口網站產品，您可以建立組織的 APIs 的單一目錄，並在整個 API 生態系統中強制執行控管標準。同時，共享入口網站產品可讓 API 供應商靈活地在其自己的帳戶中開發、測試和維護 APIs。

## 考量事項
<a name="apigateway-portals-share-resources-considerations"></a>

下列考量可能會影響您共享入口網站資源的方式：
+ 當您與其他帳戶共用產品時，該帳戶無法修改 REST API 的任何屬性。這包括整合端點、授權策略或階段組態。
+ 當您將另一個帳戶的入口網站產品新增至入口網站時，入口網站產品擁有者無法檢視或控制入口網站的任何其他屬性。入口網站產品擁有者只會知道入口網站正在使用該產品。
+ API Gateway 入口網站產品會在 AWS 區域 層級共用。
+ 您可以與多個主體使用一個資源分享，並在建立資源分享後，為其新增更多主體。建議您盡可能重複使用資源分享。
+ 如果兩個帳戶都在使用 的相同組織中 AWS Organizations，則會自動接受資源共用。您仍然需要使用 AWS RAM建立資源分享。
+ 如果兩個帳戶都在使用 的相同組織中， AWS Organizations 且組織內的資源共用已啟用，則與您共用的組織中的任何主體都會自動獲得資源共用的存取權。不需要邀請函的，可以略過資源分享。
+ 如果您共用產品的帳戶在 **12 小時內**不接受資源共用，您必須再次共用資源。
+ 在您建立資源共享之後， 會 AWS RAM 更新產品的產品共享政策，以防止在沒有明確存取的情況下`allow`存取委託人。如需詳細資訊，請參閱《IAM 使用者指南》中的[判斷帳戶中的請求獲得允許或遭到拒絕。](https://docs.aws.amazon.com//IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-denyallow)

  更新的資源政策如下所示：

  ```
  {
      "Version": "2012-10-17",		 	 	 
      "Statement": [
          {
              "Effect": "Allow",
              "Action": [
                  "apigateway:GetProduct",
                  "apigateway:ListEndpoints",
                  "apigateway:ListPages",
                  "apigateway:GetEndpoint",
                  "apigateway:GetPage"
              ],
              "Resource": [
                  "arn:aws:apigateway:us-east-1:111122223333:/portalproducts/product-id",
                  "arn:aws:apigateway:us-east-1:111122223333:/portalproducts/product-id/*"
              ]
          }
      ]
  }
  ```

  AWS RAM 已透過新增下列項目，阻止主體沒有明確允許將您的產品新增至其入口網站的存取權：

  ```
  "StringNotEquals": { "aws:PrincipalAccount": "555555555555" }
  ```

若要了解如何共用產品，請參閱 [在 API Gateway 中與入口網站擁有者共用您的入口網站產品](apigateway-portals-share-products.md)。若要了解如何將與您共用的產品新增至入口網站，請參閱 [在 API Gateway 中將共用入口網站產品新增至您的入口網站](apigateway-portals-use-shared-products.md)。

# 在 API Gateway 中與入口網站擁有者共用您的入口網站產品
<a name="apigateway-portals-share-products"></a>

身為產品擁有者，您可以與其他 AWS 帳戶 使用 的入口網站擁有者共用您的產品 AWS RAM。您可以維持對所有產品頁面和產品 REST 端點頁面的完全控制。

## 考量事項
<a name="apigateway-portals-share-products-considerations"></a>

下列考量可能會影響您共用入口網站產品的方式：
+ 您可以隨時共用或取消共用您的入口網站產品。如果您在發佈的入口網站中使用入口網站產品時取消共用入口網站產品，入口網站擁有者將無法檢視入口網站產品、檢視對其所做的任何更新，或重新發佈或預覽入口網站，直到移除入口網站產品為止。
+ 您可以檢視已與其他 帳戶共用的入口網站產品。
+ 除非您自行建立入口網站，否則您無法修改任何包含入口網站產品的入口網站。

## 分享您的入口網站產品
<a name="apigateway-portals-share-products-share"></a>

下列程序說明如何建立資源共享。

------
#### [ AWS 管理主控台 ]

若要使用 AWS 管理主控台，請參閱*AWS RAM 《 使用者指南*》中的[在 中建立資源共享 AWS RAM](https://docs.aws.amazon.com/ram/latest/userguide/working-with-sharing-create.html)。

針對**選取資源類型**，選擇 **API Gateway 產品**。

------
#### [ AWS CLI ]

下列 [create-resource-share](https://docs.aws.amazon.com/cli/latest/reference/ram/create-resource-share.html) 會為您的私有自訂網域名稱建立資源分享。資源和委託人可能需要幾分鐘的時間才能完成關聯。對於主體，請提供帳戶 ID 或 Organizations ID，例如 `arn:aws:organizations::123456789012:organization/o-1234abcd`。您可以為資源分享提供多個主體。

```
aws ram create-resource-share \ 
 --region us-west-2 \ 
 --name portal-product-resource-share \ 
 --permission-arns arn:aws:ram::aws:permission/AWSRAMDefaultPermissionAPIGatewayDeveloperPortalProduct \ 
 --resource-arns arn:aws:apigateway:us-west-2:111122223333:/portalproducts/p000000000 \ 
 --principals 222222222222
```

------

若要取消共用入口網站產品，請使用 AWS RAM 刪除資源共用。

您可以隨時修改產品共用政策，以修改哪些主體可以在其入口網站中使用您的入口網站產品。

**更新產品共用政策**

1. 在以下網址登入 API Gateway 主控台：[https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway)。

1. 在主導覽窗格中，選擇**入口網站產品**。

1. 選擇產品。

1. 在**產品共用**索引標籤中，針對**產品共用政策**，選擇**管理產品共用政策**。

1. 如果您之前沒有共用您的產品，您的產品共用政策將拒絕對入口網站產品的其他帳戶的所有存取。您需要更新政策，以允許特定帳戶存取您的入口網站產品。

1. 更新產品共用政策後，請選擇**儲存變更**。

# 在 API Gateway 中將共用入口網站產品新增至您的入口網站
<a name="apigateway-portals-use-shared-products"></a>

身為入口網站擁有者，您可以使用入口網站中其他帳戶與您共用的入口網站產品。您可以維護入口網站的完整控制權。

## 考量事項
<a name="apigateway-portals-use-shared-products-considerations"></a>

下列考量可能會影響您共享入口網站資源的方式：
+ 您必須接受產品擁有者的產品資源共享，才能在入口網站中使用其產品。如果您和產品擁有者位於相同的 Organizations， AWS RAM 可以為您完成一些共用步驟。
+ 如果產品擁有者在您發佈的入口網站中取消共用產品，該產品仍會顯示在入口網站上，但在您移除此產品之前，您將無法再次發佈入口網站。身為入口網站擁有者，您有責任從入口網站移除產品，因為產品擁有者無法為您執行此操作。
+ 您可以檢視入口網站產品、產品頁面和產品 REST 端點頁面，但您無法修改任何這些資源。
+ 如果產品與您共用，您就無法與其他帳戶共用。

## （選用） 接受資源共享
<a name="apigateway-portals-use-shared-products-accept"></a>

產品擁有者建立資源共享後，您有 **12 小時**的時間可以接受它。如果您使用 AWS Organizations 與產品擁有者位於相同的組織中，則系統會自動接受共用。如果您所在的組織已啟用自動分享資源，則會自動與您分享資源。

------
#### [ AWS 管理主控台 ]

若要使用 AWS 管理主控台，請參閱*AWS RAM 《 使用者指南*》中的[接受和拒絕資源共用邀請](https://docs.aws.amazon.com/ram/latest/userguide/working-with-shared-invitations.html)。

------
#### [ AWS CLI ]

若要尋找與您共用的所有資源，請使用下列 [get-resource-share-invitations](https://docs.aws.amazon.com/cli/latest/reference/ram/get-resource-share-invitations.html) 命令：

```
aws ram get-resource-share-invitations \
    --region us-west-2
```

使用產生的資源分享 ARN，接受資源分享邀請。下列 [accept-resource-share-invitation](https://docs.aws.amazon.com/cli/latest/reference/ram/accept-resource-share-invitation.html) 命令接受資源分享。

```
aws ram accept-resource-share-invitation \
    --resource-share-invitation-arn arn:aws:ram:us-west-2:123456789012:resource-share-invitation/1e3477be-4a95-46b4-bbe0-c4001EXAMPLE \
    --region us-west-2
```

------

## 將共用產品新增至您的入口網站
<a name="apigateway-portals-use-shared-products-add"></a>

接受資源共享之後，您可以將產品新增至入口網站。

------
#### [ AWS 管理主控台 ]

**將共用產品新增至入口網站**

1. 在以下網址登入 API Gateway 主控台：[https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway)。

1. 在主導覽窗格中，選擇**入口網站**。

1. 選擇入口網站。

1. 在**產品**索引標籤中，針對**入口網站產品**，選擇**新增產品**。

1. 將產品新增至您的入口網站。共用產品會在產品清單中顯示為 `shared` 。

1. 選擇**儲存變更**。

------
#### [ AWS CLI ]

若要尋找與您共用的所有入口網站產品，請使用下列`get-portal-products`命令：

```
aws apigatewayv2 get-portal-products \
    --resource-owner OTHER_ACCOUNTS \
    --region us-west-2
```

若要將共用入口網站產品新增至您的入口網站，請使用下列`update-portal`命令：

```
aws apigateway update-portal \
    --included-portal-product-arns arn:aws:apigateway:us-west-2:111122223333:/portalproducts/p000000000 \
    --region us-west-2
```

------

# 針對入口網站中的 API Gateway 產品 REST 端點啟用試用
<a name="apigateway-portals-try-it"></a>

使用嘗試讓 API 取用者從您的入口網站叫用您的產品端點。當 API 取用者使用 試用時，他們會輸入方法請求參數並叫用您的產品端點。然後，API Gateway 會透過公有網際網路叫用您的 API，並在 try it 視窗中傳回回應。您可以使用自訂產品頁面，提供有關存取 API 所需參數的任何其他資訊。

API Gateway 使用以下限制來保護您的 APIs：
+ API Gateway 每秒只允許 3 個請求到您的 API。
+ API Gateway 使用內建逾時限制 29000 毫秒。您的實際 API 可能會有較高的逾時限制，但當客戶使用 API Gateway 時，不會套用此逾時。
+ API Gateway 會將回應承載限制為 6MB。

## 考量事項
<a name="apigateway-portals-try-it-considerations"></a>

下列考量可能會影響您使用它的方式：
+ 當您預覽入口網站時，不支援嘗試。
+ 具有下列功能的 REST APIs 不支援嘗試：
  + 私有 API
  + 使用交互 TLS APIs 
  + 使用私有或自我簽署 SSL 憑證APIs 

  身為入口網站擁有者，您必須負責與 API 消費者通訊，因為不支援的任何 REST APIs 沒有為什麼要嘗試按鈕。API Gateway 不會為您解釋這一點。

## 針對產品 REST 端點啟用試用
<a name="apigateway-portals-try-it-procedure"></a>

下列程序說明如何為產品端點啟用試用。

若要了解如何在入口網站中使用試用，請參閱 [使用 API Gateway 入口網站](apigateway-portals-use-portal.md)。

**針對產品 REST 端點啟用試用**

1. 在主導覽窗格中，選擇**入口網站產品**。

1. 選擇產品。

1. 在**文件**索引標籤的 **API 參考頁面**下，選擇產品 REST 端點的名稱，例如 **/dogs - GET**。

1. 選擇**編輯頁面**。

1. 若要讓客戶在您的入口網站中叫用您的 API，請選取**試用功能**。

1. 選擇**儲存變更**。

1. 您必須重新發佈任何使用此入口網站產品的入口網站，變更才會生效。

# 在 API Gateway 中刪除入口網站產品
<a name="apigateway-portals-delete-product"></a>

當您刪除入口網站產品時，無法復原。

## 刪除入口網站產品
<a name="apigateway-portals-delete-product-delete"></a>

下列程序說明如何刪除入口網站產品。

**刪除入口網站產品**

1. 在以下網址登入 API Gateway 主控台：[https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway)。

1. 在主導覽窗格中，選擇**入口網站產品**。

1. 選擇入口網站產品。

1. 選擇 **刪除**。

1. 確認您的選擇，然後選擇**刪除**。

1. 您必須重新發佈任何使用此入口網站產品的入口網站，變更才會生效。