记录您的API

启用此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目录视图来修改它。