管理 API 产品

<ph type="x-smartling-placeholder"></ph> 您正在查看 Apigee Edge 文档。
转到 Apigee X 文档。 信息

使用 Apigee Edge 管理界面管理 API 产品，如本部分所述。 如需使用 API 管理 API 产品，请参阅使用 Edge Management API 发布 API。

如需简要了解 API 产品，请参阅什么是 API 产品？。

探索 API 产品页面

访问 API 产品页面，如下所述。

添加 API 产品

按照下文所述，使用界面添加 API 产品。如需使用 Edge API，请参阅使用 API 配置 API 产品。

如需使用 Edge 界面添加 API 产品，请执行以下操作：

1. 访问“API 产品”页面（如本部分中所述）。
2. 点击 +API 产品。
3. 输入 API 产品的产品详细信息。
   

   字段	说明
   名称	API 产品的内部名称。API 产品创建后，您便无法修改该名称。 请勿在名称中指定特殊字符。
   显示名称	API 产品的显示名。显示名用于界面中，您可以随时进行修改。如果未指定，则系统会使用 Name 值。此字段会使用 Name 值自动填充；您可以修改或删除其内容。显示名可以包含特殊字符。
   说明	API 产品的说明。
   环境	API 产品将允许访问的环境。例如 test 或 prod。
   访问	访问权限级别。如需了解详情，请参阅访问权限级别。
   自动批准访问请求	从任何应用中启用此 API 产品的密钥请求的自动批准。如需手动批准密钥，请停用此选项。请参阅注册应用和管理 API 密钥 (UI) 和开发者应用密钥 (API)。
   配额	您希望在配额政策中引用的配额限制。输入配额值不会自动对可通过产品进行的调用数量强制施加限制。产品引用的 API 代理必须包含配额政策才能强制执行配额。如需了解详情，请参阅配额。
   允许的 OAuth 范围	如果您对 API 产品使用 OAuth，则为您希望 API 产品允许的 OAuth 范围（例如读取或应用将随其 API 调用一起发送的其他范围）。以英文逗号分隔列表的形式指定多个范围。请参阅 OAuth 范围。

4. 添加 API 产品中提供的 API 资源，包括 API 代理和资源路径。

   例如，如果您将“music”API 代理添加到具有基本路径 /music 的产品，则该 API 产品允许调用 /music。但是，如果您希望 API 产品仅允许访问 venues 资源路径，其 URI 为 /music/venues，请将 /venues 资源路径添加到产品。在这种情况下，允许调用 /music/venues?name=paramount，但对 /music/artists?name=Jack%Johnson 的调用会被阻止。

   设置特定资源路径，或者设置基本路径和所有可能的子路径，方法是将资源路径指定为 /。资源路径可以包含通配符 /** 和 /*。双星号通配符表示支持基本路径的所有子路径（但不支持基本路径）。单星号表示仅支持一个从基本路径向下一级的 URI。请参阅配置“/”、“/*”和“/**”资源路径的行为，如本部分下文所述。

   如需添加 API 资源，请执行以下操作：

   1. 点击“API 资源”部分中的添加代理或添加路径。
   2. 选择要添加 API 代理、路径，还是同时添加 API 代理和路径。

      

   3. 添加一个或多个 API 代理和资源路径。

      请注意以下几点：

      • 您定义的资源路径适用于添加到 API 产品的所有 API 代理。
      • 更广泛、较不具体的资源路径优先于更具体的资源路径。例如，如果添加 / 和 /**，则 / 资源路径优先；/** 资源路径将被忽略。

      例如：

      

   4. 点击添加或添加并启动另一个（以指定其他 API 资源）。
   。
5. （可选）使用 Apigee 远程服务目标部分将产品绑定到一个或多个远程服务目标。 除非您使用 Apigee Envoy Adapter，否则可以忽略此设置。 如需了解详情，请参阅 Apigee Envoy Adapter 的操作指南。

6. （可选）使用自定义属性部分，最多可向 API 商品添加 18 个自定义属性。

   自定义属性是可通过多种方式使用的键/值对，包括帮助控制 API 代理执行。例如，您可以创建一个名为 deprecated 且值为 true 或 false 的自定义属性。在 API 代理流中，您可以检查 API 产品的 deprecated 属性的值（例如，使用在创建自定义属性后自动提供的 verifyapikey.{policy_name}.apiproduct.deprecated 变量）。如果其值为 true（已弃用），您可以使用 Raise Fault 政策抛出错误。

7. 点击保存。

配置“/”、“/*”和“/**”资源路径的行为

下表介绍了 API 产品针对不同资源路径的默认行为。在此示例中，API 代理的基本路径为 /v1/weatherapikey。API 产品资源路径适用于基本路径后面的路径后缀。

Request URI	对 / 允许	对 /* 允许	对 /** 允许	对 /*/2/** 允许	对 /*/2/* 允许
/v1/weatherapikey	是	否	否	否	否
/v1/weatherapikey/	是	否	否	否	否
/v1/weatherapikey/1	是	有	是	否	否
/v1/weatherapikey/1/	是	有	是	否	否
/v1/weatherapikey/1/2	是	否	是	否	否
/v1/weatherapikey/1/2/	是	否	是	是	否
/v1/weatherapikey/1/2/3/	是	否	是	有	是
/v1/weatherapikey/1/a/2/3/	是	否	是	否	否

默认情况下，API 产品中的资源路径 / 支持基本路径和所有子路径。例如，如果 API 代理的基本路径为 /v1/weatherapikey，则该 API 产品支持对 /v1/weatherapikey 以及任何子路径（例如 /v1/weatherapikey/forecastrss、/v1/weatherapikey/region/CA 等）的请求。

您可以更改此默认值，以使资源路径 / 仅对应于 API 代理的基本路径，这意味着 API 产品不允许访问 / 后具有内容的 URI。如果进行此项更改，则在上表中，只有“对 / 允许”下的前两行将包含“Y”。

如需更改默认值，系统管理员必须将您组织中 features.isSingleForwardSlashBlockingEnabled 属性的值设置为 true。Cloud 客户可以提出这一请求， 转到 Apigee Edge 支持。

<ph type="x-smartling-placeholder">

修改 API 产品

如需修改 API 产品，请执行以下操作：

1. 访问“API 产品”页面（如本部分中所述）。
2. 点击要编辑的 API 产品所在的行。
3. 点击 API 产品页面上的修改。
4. 根据需要修改字段。

   您可以删除已添加到 API 产品的资源。如果资源出现故障或需要更多开发工作，您可能需要执行此操作。删除后，该资源将不再属于 API 产品。任何使用 API 产品的应用都无法再访问已删除的资源。已删除的资源会从产品中移除，但不会从系统中删除，因此其他产品仍然可以使用它们。

5. 点击保存。

借助适用于公有云的 Apigee Edge，Edge 可保持 在实体被访问后，在缓存中保留至少 180 秒。

• OAuth 访问令牌。这意味着，撤销的令牌在最多 30 秒的时间内 分钟，直到其缓存限制到期。
• 密钥管理服务 (KMS) 实体（应用、开发者、API 产品）。
• OAuth 令牌和 KMS 实体的自定义属性。

删除 API 产品

如需删除 API 产品，您必须先取消注册/取消关联与该产品关联的任何开发者应用。为此，你可以删除应用 或撤消应用的 API 密钥。

如需删除 API 产品，请执行以下操作：

1. 访问“API 产品”页面（如本部分中所述）。
2. 将光标放到列表中的 API 产品上。
3. 点击 。
4. 点击删除以确认删除操作。