drupal

Apigee API目录

• 安装API目录模块
• 记录您的API
• 呈现OpenAPI规范
• 控制对API文档的访问
• 公开REST API以与API Docs交互

呈现OpenAPI规范

最后更新于 

2019年5月31日

将OpenAPI规范作为API Doc添加到开发人员门户后，它将使用Apigee SmartDocs在其自己的API Doc页面上呈现。但是，您可以使用其他呈现格式（如Swagger UI Field Formatter）在API目录中显示文档。

例如，要使用Swagger UI呈现OpenAPI规范：

1. 安装并启用Swagger UI Field Formatter模块。
2. 按照模块页面上的说明安装Swagger UI JS库。
3. 以具有管理员或内容创建权限的用户身份登录门户。
4. 转到管理菜单中的结构> API文档设置>管理 显示。
5. 更改OpenAPI规范字段格式以使用Swagger UI字段格式化程序。
6. 单击保存。

启用此Apigee API目录模块后，系统中会创建一个名为“API Doc”的新Drupal实体，您可以使用该实体向门户添加API文档。您发布的API文档将显示在 开发人员门户的  API目录页面中。

添加新的API文档

添加API文档后，其名称，说明和可选图像将在API目标网页上以图库格式显示为卡片。您的API Doc卡可以按类别过滤并显示在API登录页面上。单击每个API Doc卡底部的View Documentation链接，您将转到API规范的Smart Docs呈现。

要添加新的API文档：

1. 以具有管理员或内容创建权限的用户身份登录门户。
2. 在Drupal管理菜单中导航到Content > API Catalog。
3. 点击+ 添加API文档。将显示“ 添加API文档”表单。
   1. 输入要添加的API文档的名称。
   2. 选择API Doc的OpenAPI规范源。OpenAPI规范可以直接上传为JSON或
      YAML文件，也可以与源位置（如Apigee Edge或URL）相关联。
      1. 要上载规范文件，请选择“ 文件”，然后使用文件选择器选择要上载的文件。
      2. 要使用URL源位置，请选择URL，然后在URL下输入OpenAPI规范文件的完整文件URL 。
   3. 为您要记录的API规范添加可选描述。一旦API Doc发布，开发人员就可以在API登录页面上看到此描述。
   4. 使用自动填充列表向API文档添加一个以上的类别。要向API文档添加多个类别，请单击“ 类别”下的“ 添加其他项 ” 。这些类别将用于过滤您的API文档，以便在API目标网页上显示。
   5. 将图像添加到API文档。该图像将显示在API文档卡上，因为它显示在API登录页面上。单击添加媒体以打开媒体对话框。您可以上传新图像文件，也可以从预填充图像库中选择和图像。
4. 单击保存。

编辑API文档

要编辑现有API文档：

1. 以具有管理员或内容创建权限的用户身份登录门户。
2. 在Drupal管理菜单中导航到Content > API Catalog。
3. 找到您要更改的API文档，然后单击“操作”下拉列表中的“ 编辑 ”。
4. 要更新API文档的名称，说明或类别或图像，请在相应字段中编辑信息，然后单击“ 保存”。
5. 如果OpenAPI规范文件已更改，则可以通过单击OpenAPI规范文件下的“ 删除 ” ，上载新的规范快照或URL，然后单击“ 保存”来重新导入新文件或链接到新URL 。

自定义API文档显示

API Doc是一个Drupal实体。您可以在Drupal管理菜单中的Structure > API Doc设置中对其进行修改。

该API的着陆页是一个Drupal视图。您可以通过编辑管理菜单中的结构>视图下的API目录视图来修改它。

使用Apigee Developer Portal Kickstart发行版

如果您使用Kickstart发行版安装了开发人员门户网站，则已下载Apigee API目录模块及其所有依赖项作为Kickstart安装脚本的一部分。

要启用该模块：

1. 在Drupal管理菜单中选择Extend。
2. 选择Apigee API目录模块。
3. 单击安装。

作为独立模块安装

此模块必须安装在由Composer管理的Drupal站点上。Drupal.org提供了有关如何使用Composer管理Drupal站点依赖关系以便快速入门的文档。

1. 使用Composer安装模块。Composer将下载该模块及其所有依赖项。

   注意：必须在Drupal安装的根目录下执行Composer。例如：

   cd / path / to / drupal / root 作曲家需要drupal / apigee_api_catalog

   有关使用Composer安装提供的模块的更多信息，请阅读如何使用Composer 下载提供的模块和主题。

2. 在Drupal管理菜单中选择Extend。
3. 选择Apigee API目录模块。
4. 单击安装。

Apigee的API目录模块允许您使用OpenAPI规范和Apigee SmartDocs在Drupal 8开发人员门户中记录您的API。将API文档发布到门户网站使您的开发人员可以轻松地学习，测试和评估您的API。

安装API目录模块

Apigee的API目录模块允许您使用OpenAPI规范和SmartDocs在Drupal 8开发人员门户中记录您的API。

记录您的API

创建API文档以使用OpenAPI规范和SmartDocs描述您的API。

呈现OpenAPI规范

您可以使用社区模块在Apigee API目录中呈​​现OpenAPI规范。

控制对API文档的访问

使用权限管理对API目录和API文档的访问。

公开REST API以与API Docs交互

设置REST API以创建，读取，更新或删除API Docs实体。

相关项目

Apigee API目录 8.x-1.0

相关内容

Apigee Edge

Apigee Edge模块使您可以将Drupal 8站点与Apigee Edge集成。

尝试添加内容（节点/添加）后，如果所选内容类型配置为只有一个节点且已经有一个节点以实际语言创建，则会重定向以编辑节点，否则，您将进入创建一个新节点。

要配置模块设置，请访问“设置”页面（admin / config / content / onlyone / settings），如果要在名为“添加内容（仅限一个）”的新菜单条目中包含已配置的内容类型，则必须选中“选项”在新菜单条目中显示已配置的内容类型？'。

新的菜单链接将在“内容”页面（管理员/内容）中显示，作为“添加内容（仅限一个）”页面的操作链接（仅限一个/添加），然后是“添加内容”页面（节点/添加） ）将显示未配置的内容类型。为此，您需要“  仅管理一个”  权限。

要配置内容类型以允许每种语言只有一个节点，请访问“仅一个”页面（admin / config / content / onlyone），在“  仅一个可用内容类型”  部分中  检查  应具有“仅一个”节点的内容类型每种语言。为此，您需要“  仅管理一个”  权限。

提交内容类型配置表单并更改后，将 调度事件  Drupal \ onlyone \ OnlyOneEvents :: CONTENT_TYPES_UPDATED以通知已配置内容类型的更改。此信息对于实现其他模块非常有用，这些模块可创建链接以添加内容或在站点上执行其他操作。

仅允许管理工具栏使用一次内容类型（仅限一个）

处理与配置的内容类型相关的管理工具栏工具模块菜单条目的修改。

“仅允许内容类型”模块允许在此配置的所选内容类型中为每种语言创建“仅一个节点”。

附加模块

“仅允许内容类型一次（仅一个）”模块附带的其他模块。

• 仅允许管理工具栏使用一次内容类型（仅限一个）

配置内容类型

说明如何配置内容类型以允许每种语言只允许一个节点。

配置模块设置

阅读以了解如何配置模块设置以及内容创建中引入的更改。

创建节点

描述在尝试创建新节点后模块的工作方式。

相关项目

仅允许内容类型一次（仅限一次） 8.x.

在这个基本的例子中，我们将创建一个Alexa技能，你可以通过说“Alexa，从纽约市问问你好的drupal”从你的Echo调用，Alexa将回复“你好Drupal到纽约市”。

有关如何为Alexa Skills设置交互模型的大量文档。请参阅：  https：//developer.amazon.com/public/solutions/alexa/alexa-skills-kit/get ...

要求

对于与Alexa服务集成必须满足的Drupal站点有一些要求：

1. 您的网站必须可以在线访问 - 亚马逊的Alexa服务将向您网站上的/ alexa / callback路径发送请求。
2. Alexa Service回调只能通过HTTPS进行，因此您的站点必须支持它。在技​​能开发期间可以使用自签名证书，但是需要由受信任的证书颁发机构签署的证书才能发布技能。

创建亚马逊技能

1. 转到  https://developer.amazon.com  并使用您的亚马逊帐户登录。
2. 单击   顶部菜单中的Alexa。
3. 选择  Alexa Skills Kit  并添加一项新技能，称之为  Hello Drupal，并填写以下表格：

• 对于  技能类型，请选择  自定义交互模型
• 为您的技能提供描述性名称
• 对于  Invocation Name，请使用您选择的短语，例如M y Application
• 在“ 交互模型”选项卡上
  • 对于  Intent Schema，复制并粘贴alexa_demo / sample_intents.json的内容 
  • 对于  Sample Motterances，复制并粘贴alexa_demo / sample_utterances.txt的内容 
• 在“ 配置”选项卡上
  • 对于服务端点类型，请选择HTTPS
  • 选择离您的客户最近的地理区域
  • 在您所在地区的文本框中输入端点URL。它们应采用以下形式：https：  //your.site/alexa/callback
  • 为  帐户关联选择否
• 在“ SSL证书”选项卡上，选择您的站点使用的SSL证书类型。如果您使用的是自签名证书，则需要上传。
• 保存配置。
• 在技能信息  选项卡上  记下应用程序ID。它应该是这样的：  amzn1.ask.skill.11111111-2222-3333-4444-555555555555

与Drupal集成

1. 使用Composer 安装Alexa模块：。您应该从整个Drupal站点的composer.json所在的任何位置运行此命令。
   composer require "drupal/alexa"
2. 启用Alexa模块。
3. 启用Alexa Demo（alexa_demo）模块。
4. 以管理员身份登录您的站点后，转到配置 - > Alexa配置并输入您之前记录的应用程序ID。

测试

如果您有Amazon Echo，并且它与 您用于开发此技能的相同亚马逊帐户相关联  ，您现在可以说：  Alexa，从{your city}询问{您的调用名称} hello drupal

如果您尚未安装Amazon Echo或者您想快速测试技能集成，请返回Amazon Developer控制台上的Alexa Skill。在“  测试”  选项卡中，您可以在服务模拟器中键入与您在Amazon Echo设备中说的内容等效的文本。通过输入“帮助”并单击“ 询问{您的邀请名称}”按钮进行尝试。您应该收到一个JSON响应，如下所示：

{ "version": "1.0", "response": { "outputSpeech": { "type": "PlainText", "text": "You can ask anything and I will respond with \"Hello Drupal\"" }, "shouldEndSession": false }, "sessionAttributes": {} }