浏览 API
API Hub 是开发者门户的主页,你可以在其中发现和探索可用的 API 产品。本指南介绍如何浏览和搜索 API,以及查看 API 文档。
访问 API Hub
从开发者门户的顶部导航栏进入 API Hub。API Hub 会根据产品的可见性设置,显示你有权查看的所有已发布 API 产品:
- Public 产品对所有访问者可见,包括未经过身份认证的用户(前提是门户已启用公开访问)。
- Logged-in 产品仅在登录后可见。
浏览 API 产品
API Hub 中的每个 API 产品卡片都会显示:
- Name:产品显示名称。
- Description:API 所提供内容的简短摘要。
- Labels:用于对产品分类的标签。
单击产品卡可查看其详细信息。
查看 API 产品详情
API 产品详情页面显示:
API 文档
对于网关产品,API 文档是根据链接服务的 OpenAPI 规范生成的。你可以浏览:
- Endpoints:所有可用的 API 路径和 HTTP 方法。
- Request parameters:路径参数、查询参数、请求头和请求正文 Schema。
- Response schemas:预期的响应格式和状态码。
- Server URLs:托管 API 的基础 URL。
对于外部产品,文档是根据上传的 OpenAPI 规范呈现的。
身份认证要求
详细信息页面显示产品支持的身份认证类型(API Key(API 密钥)身份认证、基本身份认证或 OAuth)。这有助于你了解订阅后需要创建什么类型的凭证。
订阅状态
如果你已登录,该页面会显示你的应用程序是否已订阅该产品。
可见性和访问
你在 API Hub 中看到的内容取决于产品配置:
| 你的状态 | Public 产品 | Logged-in 产品 |
|---|---|---|