本页面适用于 Apigee 和 Apigee Hybrid。
API 页面提供了有关 API 的详细信息。从 API 列表页面中选择 API 时，系统会显示 API 页面的概览标签页。
概览标签页包含以下部分：
常规
常规窗格显示有关 API 的顶级信息，包括以下内容：
- 显示名：API 的显示名；在注册 API 时定义。如需修改显示名，请参阅修改 API 注册详细信息。
- 说明：API 的说明；在注册 API 时定义。如需修改说明，请参阅修改 API 注册详细信息。
- 系统和自定义分类元素
- 文档版本：用于打开当前分配给部署的规范修订版本的链接。仅当 API 设置了推荐的部署且该部署分配有版本时，才会显示此按钮。
- 获取访问权限：提供有关如何访问此 API 的说明。如需修改这些说明，请参阅修改部署。 仅当存在推荐的部署集时，才会显示此按钮。
如果未知标签或标记是通过公共 API 附加的，则不会显示在该界面中。系统仅显示定义已知分类的标签。
您可以为分类值指定文本说明或网址。在此窗格中，如果为分类值指定了文本说明，则将鼠标悬停在该值上时，该值旁边显示的 信息图标会显示相关说明。如果值为网址，则显示的分类值会变为超链接，点击该超链接会在新的浏览器标签页中打开该网址。如需了解详情，请参阅添加分类。
修改 API
请参阅修改 API 注册详细信息。
删除 API
请参阅删除 API。
统计信息摘要图表
统计信息摘要图表有助于团队了解 API 质量的衡量方式。在一系列 API 中，采取明智的评分方法有助于推动实现不同方面的一致性，例如设计标准、安全配置文件、可靠性或其他对业务至关重要的维度。API hub 具有已配置的 OpenAPI lint 检查功能。
统计信息摘要图表代表一组不容易减少为单个数量的得分。
得分是一个值，表示 API 质量的某个方面。质量可以在任何上下文（设计、可靠性、合规性等）中进行定义，并且通常涉及观点。
隐藏统计信息摘要图表
如需隐藏每个 API 的统计信息摘要图表界面，请参阅停用或启用 API 统计信息摘要图表。
选择统计信息摘要图表版本
在对此规范评分下拉列表中，选择要用于统计信息摘要图表的版本：
其中：
- 最新：此规范修订版本具有最新的上传时间戳。
- 推荐：此规范将其某个修订版本分配给推荐的部署。如果您是 API 使用方，请使用此规范。
自定义统计信息摘要图表
如需自定义和配置统计信息摘要图表，请使用注册表命令行工具。
另请参阅如何计算得分？
如果您要在统计信息摘要图表上的错误和警告旁边显示状态图标，请定义阈值：
其中：
| 类型 | 图标 | 说明 |
|---|---|---|
| 提醒 |  |
当阈值在为提醒定义的范围内时显示此图标。 |
| 警告 |  |
当阈值在为警告定义的范围内时显示此图标。 |
| 确定 |  |
当阈值在为正常定义范围内时显示此图标。 |
Lint 摘要
API hub 统计信息摘要图表默认配置会报告已上传到 API hub 的 OpenAPI v2 和 OpenAPI v3 规范的 lint 警告和 lint 错误。API hub 和注册表包含基于 Spectral 的默认 linter。 此 linter 作为 lint 检查功能的参考示例提供（预期不支持 Spectral 本身），使用 OpenAPI 规则的规则集并支持一些例外情况，以减少常见错误的干扰。目前不支持使用自定义 linter 进行扩展。
如需了解如何更新 linter 配置，请参阅注册表中的 API 样式指南。
Deployment
部署标签页显示由 API Editor 配置的 API 的所有部署。“部署”表示部署了 API 的活跃环境。部署按环境名称排序（降序）。系统会显示以下信息：
- 环境
- 文档
- 推荐的部署指标
- 网关
- 使用指南
- 外部渠道
- 获取访问权限
如需了解详情，请参阅管理部署。
版本
版本标签页会显示已为 API 定义的所有版本。版本按版本号排序（降序）。系统会显示以下信息：
- 版本
- 生命周期阶段
- 上次修订日期
- 服务终止
如需了解详情，请参阅管理版本。
相关参考
API 概览页面底部的相关窗格提供了与 API 相关的各类信息的链接。例如，实现源代码、设计文档和基础架构系统。如需了解详情，请参阅相关内容。
依赖项
API 概览页面底部的依赖项窗格列出了 API 的所有依赖项，包括其他内部 API（位于 API Hub 中）、外部第三方 API（不在 API Hub 中）以及其他生产系统。例如，数据库和存储解决方案。如需了解详情，请参阅依赖项。
