本页面适用于 Apigee 和 Apigee Hybrid。
查看 Apigee Edge 文档。
在此步骤中,您将通过执行以下步骤,将 API 发布到门户:
第 1 步:根据规范创建 API 代理
根据描述 API 的 OpenAPI 规范创建 API 代理。
如需根据 OpenAPI 规范创建 API 代理,请执行以下操作:
- 在 Apigee 界面中,选择左侧导航栏中的开发 > API 代理以打开 API 代理页面。
点击新建。
系统会打开“创建代理”向导,提示您选择要创建的 API 代理的类型。
在反向代理(最常见)下,点击使用 OpenAPI 规范。
此时将显示使用 OpenAPI 规范对话框。
将以下网址复制并粘贴到网址标签页上的 OpenAPI 规范网址 (OpenAPI Spec URL) 字段中:
https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml
点击选择。
系统会打开创建代理向导,并使用 OpenAPI 规范中的值预填充代理详情 (Proxy details) 页面。按照以下说明修改说明字段:适用于 hello world 的 API 代理 (API proxy for hello world)。
点击下一步。
在政策页面上,执行以下操作:
- 在安全性:授权 (Security: Authorization) 下,选择直通(无授权)(Pass through (no authorization))。
- 在安全性:浏览器 (Security: Browser) 下,选择添加 CORS 标头 (Add CORS headers)。
点击下一步。
在流 (Flows) 页面上,确保选中所有操作,然后点击下一步 (Next)。
在摘要页面上,在可选部署 (Optional Deployment) 下选择要部署到的环境。
点击创建和部署 (Create and deploy)。
在摘要页面上,您会看到一条确认消息,表示新的 API 代理已成功创建并部署到所选环境。
第 2 步:创建 API 产品
创建一个 API 产品,其中包含您要向 API 使用方公开的 API 资源。
如需创建 API 产品,请执行以下操作:
- 在 Apigee 界面中,选择发布 > API 产品,打开“API 产品”页面。
-
点击 +创建 (+CREATE)。
此时会显示“产品”(Product) 页面。 -
输入 API 产品的产品详细信息。
注意:当您发布 API 产品时,显示名和说明字段会显示在门户中。您可以在第 3 步:将 API 发布到您的门户中修改上述值。
字段 值 姓名 Hello World 显示名 Hello World 说明 简单的 hello world 示例 环境 选择在其中部署 API 代理的环境。 访问权限 公开 自动批准访问请求 已启用 配额 (留空) 允许的 OAuth 范围 (留空) - 在操作 (Operations) 部分中,点击添加操作 (ADD AN OPERATION) 以标识要添加到 API 产品的操作。
- 在来源 (Source) 下,点击 API 代理 (API proxy),然后从下拉列表中选择 Mock-Target-API。
- 在操作 (Operation) 下的路径 (Path) 字段中输入正斜杠 (
/
)。忽略其他字段。 - 点击保存以保存该操作。
- 此时会显示添加操作 (Add Operation) 对话框。
- 点击添加。
- 点击保存。
第 3 步:将 API 发布到您的门户
将 API 发布到您的门户,以便您的客户了解并使用 API。
如需将 API 发布到您的门户:
- 在 Apigee 界面中,导航到门户中的 API 页面:
- 在左侧导航栏中选择发布 > 门户。
- 点击我的第一个门户 (My first portal) 行以打开该门户。
- 点击 API 目录 (API Catalog) 以显示 API 页面。
- 点击 +。
- 在将 API 产品添加到目录 (Add an API product to the catalog) 对话框中,选择 Hello World,然后点击下一步。
- 在 API 详细信息 (API details) 下,配置以下选项:
- 选择已发布(在目录中列出) (Published (listed in the catalog)) 以将 API 发布到您的门户。
- 在显示图片部分中,执行以下操作:
- 点击选择图片。
- 在选择图片 (Select image) 对话框中,点击现有图片列表中的
home-background.jpg
。 - 点击选择。
- 预览图片,然后点击选择。
- 对于类别部分,输入开始使用,然后按 Enter 键。
让所有其他值保留为默认值。
- 在 API 文档下,如需通过 OpenAPI 规范的快照自动生成 API 参考文档,请执行以下操作:
- 选择 OpenAPI 文档 (OpenAPI document)。
- 点击选择文档。
- 选择从网址导入 (Import from a URL) 标签页。
- 在规范名称 (Spec name) 字段中输入 helloworld。
- 将以下网址复制并粘贴到网址 (URL) 字段中,然后按 Enter 键:
https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml
- 点击选择。
- 点击保存。
如需查看 API 参考文档,请执行以下操作:
- 在 Apigee 界面中,点击实时门户以查看实时门户中的更改(如果实时门户已在另一个标签页中打开,请进行刷新)。
- 在实时门户中:
a. 在顶部导航栏中点击 API 以查看已发布的 API。
b.点击 Hello World 卡片以查看 API 参考文档。
c.试用您的 API!