浏览 API
API 中心是 开发者门户的主页,你可以在其中发现和探索可用的 API 产品。本指南向你展示如何浏览、搜索和查看 API 文档。
访问 API 集线器
从开发者门户的顶部导航栏导航至 API 中心。 API 中心根据产品的可见性设置显示你可见的所有已发布的 API 产品:
- 公共产品对所有访问者都可见,包括未经身份验证的用户(如果在门户上启用了公共访问)。
- 登录产品仅在你登录后可见。
浏览 API 产品
API 集线器中的每个 API 产品卡显示:
- 名称:产品显示名称。
- 描述:API 提供的内容的简短摘要。
- 标签:对产品进行分类的标签。
单击产品卡可查看其详细信息。
查看 API 产品详情
API 产品详情页面显示:
API 文档
对于网关产品,API 文档是根据链接服务的 OpenAPI 规范生成的。你可以浏览:
- 端点:所有可用的 API 路径和 HTTP 方法。
- 请求参数:路径参数、查询参数、标头和请求正文架构。
- 响应模式:预期的响应格式和状态代码。
- 服务器 URL:托管 API 的基本 URL。
对于外部产品,文档是根据上传的 OpenAPI 规范呈现的。
身份验证要求
详细信息页面显示产品支持的身份验证类型(密钥身份验证、基本身份验证或 OAuth)。这有助于你了解订阅后需要创建什么类型的凭证。
订阅状态
如果你已登录,该页面会显示你的应用程序是否已订阅该产品。
可见性和访问
你在 API 集线器中看到的内容取决于产品配置:
| 你的状态 | 公共产品 | 登录产品 |
|---|---|---|
| 未登录 | 可见(如果启用公共访问) | 不可见 |
| 已登录,未订阅 | 可见的。根据产品设置,API 详细信息可能可见。 | 可见的。根据产品设置,API 详细信息可能可见。 |
| 登录,订阅 | 完全访问 | 完全访问 |
某些产品可能允许未订阅的开发者查看 API 文档,但仅限订阅的开发者查看某些内容(例如试用功能)。
后续步骤
找到满足你需求的 API 产品后: