构建简单的 API 代理

Edge

如需使用 Edge 界面访问“创建代理”向导，请执行以下操作：

1. 登录 apigee.com/edge。
2. 在左侧导航栏中，选择开发 > API 代理。
3. 点击 +代理。

系统会显示“创建代理”向导，引导您完成生成相应功能并向 API 代理添加基础功能的步骤。

传统 Edge（私有云）

如需使用传统 Edge 界面访问“创建代理”向导，请执行以下操作：

1. 登录 http://ms-ip:9000，其中 ms-ip 是管理服务器节点的 IP 地址或 DNS 名称。
2. 选择 API >API 代理。
3. 点击 + API 代理。

系统会显示“创建代理”向导，引导您完成生成相应功能并向 API 代理添加基础功能的步骤。

Edge

1. 按照前面部分中的使用界面创建 API 代理所述，访问“创建代理”向导。
2. 在“创建代理”向导中，点击反向代理（最常见）。要根据现有的有效 OpenAPI 规范生成代理，请点击使用 OpenAPI 规范。如需详细了解此选项，请参阅使用 OpenAPI 规范生成代理。
3. 在向导的详细信息页面上，输入以下信息。

   字段	说明
   名称	为您的 API 显示的名称。指定字母数字字符、短划线 (-) 或下划线 (_)。
   基本路径	显示在 API 代理的 http(s)://[host] 地址之后的 URI 片段。Edge 使用基本路径 URI 来匹配和路由传入的请求消息 正确的 API 代理 注意：API 代理基本路径默认为 Name 字段指定的值，且全部为小写。 基本路径后是任何其他资源网址。以下是客户端用于调用您的 API 代理的完整网址结构： https://[host]/base_path/conditional_flow_path 注意：基本路径必须是唯一的，您无法部署具有相同基本路径的两个 API 代理。如果您修改已部署的 API 代理 并将基路径设置为与其他 API 代理的基路径相同的值，则 Edge 会自动取消部署 API 代理。在重新部署 API 代理之前，必须修改基本路径以使其唯一。 在基本路径中使用通配符 在 API 代理基本路径中使用一个或多个 /*/ 通配符，以使您的 API 代理可适应未来的需求。例如，/team/*/members 的基本路径允许客户端调用 https://[host]/team/blue/members 和 https://[host]/team/green/members，而无需创建新的 API 代理来支持新团队。请注意，不支持 /**/。
   说明	（可选）API 的说明。
   目标（现有 API）	此 API 代理调用的后端服务网址。

4. 在向导的通用政策页面上，配置以下各项：
   • 安全性：授权下的安全授权要求。请参阅本部分后面的添加安全性。
   • 支持安全性：浏览器下的跨域资源共享 (CORS)。请参阅本部分后面的添加对 CORS 的支持。
   • 配额可用于在配额下保护后端服务免遭高流量访问。参见配额。（如果选择了直通式授权，则不会显示。）
   • 在获利下，对启用了获利功能的组织强制执行获利限制。请参阅对 API 代理实施获利限制。
5. 在向导的虚拟主机页面上，选择 API 代理在部署时将绑定到的虚拟主机。如需了解详情，请参阅关于虚拟主机。
6. 在摘要页面上，根据需要选择部署环境，然后点击创建和部署。

   新的 API 代理会在所选环境中创建和部署。

7. 点击修改代理，以显示 API 代理的详细信息页面。

传统 Edge（私有云）

1. 按照前面部分中的使用界面创建 API 代理所述，访问“创建代理”向导。
2. 在“Build a Proxy”向导中，选择Reverse Proxy（最常用）。接收者 如需根据现有的有效 OpenAPI 规范生成代理，请点击使用 OpenAPI。 如需详细了解此选项，请参阅下文的使用 OpenAPI 规范生成代理。
3. 点击下一步。
4. 在向导的 Details 页面上，输入以下信息。

   字段	说明
   代理名称	为您的 API 显示的名称。
   代理基本路径	代理基本路径是 API 代理。Edge 使用基本路径 URI 来匹配和路由传入的请求消息 正确的 API 代理 注意：如需查看 Apigee 关于 API 版本控制的建议，请参阅 Web API 设计：缺失的环节中的版本控制 电子书。 基本路径之后是任何其他资源网址。以下是完整网址 结构： https://[host]/base_path/conditional_flow_path 注意：基本路径必须是唯一的。如果您以后修改此代理 并将其基本路径设置为与另一个 API 代理相同 保存后，系统会自动取消部署。您必须先修改基本路径， 您就可以重新部署它 在基本路径中使用通配符 您可以在 API 代理基本路径中使用一个或多个 /*/ 通配符 您的代理可以满足未来需求。例如，基本路径 /team/*/members 允许客户端调用 https://[host]/team/blue/members 和另外 https://[host]/team/green/members 人（不包括你） 因此需要创建新的 API 代理来为新团队提供支持。请注意，/**/ 不是 支持。 注意：代理基本路径默认为为 代理名称会全部转换为小写形式，除非您明确修改 代理基本路径字段。
   现有 API	API 平台代表通过 API 代理网址。
   说明	API 的说明。

5. 在向导的 Security 页面上，进行以下配置： <ph type="x-smartling-placeholder">
   </ph>
   • 安全身份验证要求。请参阅本部分后面的提高安全性。
   • 支持跨源资源共享 (CORS)。请参阅本部分后面的添加对 CORS 的支持。
6. 在向导的虚拟主机页面上，选择 API 代理在部署后要绑定到的虚拟主机。如需了解详情，请参阅关于虚拟主机。
7. 选择部署环境，然后点击构建和部署
   系统会发送确认信息，确认您的新 API 代理已成功创建 并将其部署到选定的环境中
8. 点击 查看<代理名称>代理以显示 API 代理的详情页面。

Edge

如需从 API 代理软件包导入 API 代理，请执行以下操作：

1. 按照前面部分中的使用界面创建 API 代理所述，访问“创建代理”向导。
2. 点击上传代理软件包。
3. 在代理向导的上传代理软件包页面上，输入以下信息。
   
   

   字段	说明
   ZIP 软件包	包含 API 代理配置的 ZIP 文件。拖放或点击进入该文件。
   名称	为您的 API 显示的名称。默认为不带扩展名的 ZIP 文件的名称。

4. 点击下一步。
5. 在摘要页面上，根据需要选择部署环境，然后点击创建和部署
   系统将显示确认消息，确认新 API 代理已成功创建。
6. 点击修改代理，以显示 API 代理的详细信息页面。

传统 Edge（私有云）

1. 按照前面部分中的使用界面创建 API 代理所述，访问“创建代理”向导。
2. 在“Build a Proxy”向导中，选择Proxy bundle。
3. 点击下一步。
4. 在代理向导的详情页面上，输入以下信息。
   
   

   字段	说明
   ZIP 文件包	点击 Choose File（选择文件），然后找到包含 API 代理配置。
   代理名称	为您的 API 显示的名称。

5. 查看 build 信息，然后点击 Build。
   如果成功，系统会显示一条消息，并且 Edge 会自动将导入的 API 代理部署到所选环境 组织中。API 代理公开的 API 可供调用。
6. 点击查看 <代理名称>代理以显示 API 代理的详情页面。
7. 要部署代理，请点击部署下拉列表，然后选择 环境，然后回答提示。

Edge

如需使用 Edge 界面创建 API 代理的新修订版本，请执行以下操作：

1. 登录 apigee.com/edge。
2. 在左侧导航栏中，选择开发 > API 代理。
3. 点击要复制的列表中的 API 代理。
4. 依次选择项目 > 保存为新版本。

传统 Edge（私有云）

如需使用传统版 Edge 界面创建 API 代理的新修订版本，请执行以下操作：

1. 登录 http://ms-ip:9000，其中 ms-ip 是管理服务器节点的 IP 地址或 DNS 名称。
2. 在顶部导航栏中依次选择 API > API 代理。
3. 点击您要复制的列表中的 API 代理。
4. 依次选择项目 > 保存为新版本。

Edge

如需使用 Edge 界面复制 API 代理，请执行以下操作：

1. 登录 apigee.com/edge。
2. 在左侧导航栏中，选择开发 > API 代理。
3. 点击要复制的列表中的 API 代理。
4. 依次选择项目 > 另存为新 API 代理。
5. 在“另存为新代理”对话框中，输入新 API 代理的名称。
6. 点击添加。

传统 Edge（私有云）

如需使用传统 Edge 界面复制 API 代理，请执行以下操作：

1. 登录 http://ms-ip:9000，其中 ms-ip 是管理服务器节点的 IP 地址或 DNS 名称。
2. 在顶部导航栏中依次选择 API > API 代理。
3. 点击您要复制的列表中的 API 代理。
4. 依次选择项目 > 另存为新 API 代理。
5. 在“另存为新代理”对话框中，输入新 API 代理的名称。
6. 点击添加。