OpenAPI 门户

OpenAPI 门户

OpenAPI 门户，英文名称 OpenAPI Portal 或 OpenAPI Explorer。它是一款集 OpenAPI 智能搜索、文档、在线调试、SDK 获取、CodeSample、调用出错诊断、调用统计为一体的产品。您可以在 OpenAPI 门户中调用阿里云各云产品开放的 OpenAPI ，查看 OpenAPI 请求和返回结果。此外， OpenAPI 门户会自动生成相应 OpenAPI 的 SDK 调用示例，帮助您使用阿里云 OpenAPI 。

功能说明

网站地址： https://next.api.aliyun.com。

OpenAPI 门户要求开发者必须登录，通过用户登录身份，系统会自动获取可用的 AK 信息，调用 OpenAPI ，无需用户在调试界面传入 AK 数据，提升 OpenAPI 调试的便捷性。

OpenAPI 门户提供以下功能：

• OpenAPI 检索

  汇集阿里云多个产品的 OpenAPI ，可以在此集中检索，快速找到您所需要的 API。

• OpenAPI 调用

  无需编写代码，在调用页面中填写请求参数，便可调用 OpenAPI 。

• 查看 OpenAPI 请求

  根据您填写的请求参数自动生成 OpenAPI 请求，并打印到网页上，让您直观地查看到真实发送的 OpenAPI 请求。

• 结构化输出返回结果

  根据 OpenAPI 请求，返回真实的 OpenAPI 调用结果，结构化输出。

• 生成 SDK 调用示例

  根据输入的 OpenAPI 请求参数，自动生成多种语言的 SDK 调用示例。

• 命令行调用

  提供网页版命令行工具，模拟 Linux 操作体验使用命令行调用 OpenAPI 。

使用场景

查看 OpenAPI 文档

OpenAPI 门户提供完整的 OpenAPI 文档，包含接口说明、流控信息、授权信息、请求参数、返回数据、返回说明、返回示例、错误码、变更历史等。您可通过阅读 OpenAPI 文档判断它是否能够满足您的业务场景。

OpenAPI 调试

在基于阿里云 OpenAPI 进行二次开发前，您可以预先验证 OpenAPI 请求方式，入参和查看 OpenAPI 的返回结果。 OpenAPI 门户提供了网页和命令行两种方式调用 OpenAPI ，让您直观地查看 OpenAPI 的调用结果。而且，当调用出错时， OpenAPI 门户会提示您如何解决，帮助您快速了解 OpenAPI 功能及使用方法。

命令行调试

如果您打算编写 Shell 脚本来管理云资源，但又不清楚该如何编写操作云资源的命令，可访问 OpenAPI 门户的API 调试界面，选择 CLI 示例，查看命令行。

集成阿里云SDK

OpenAPI 门户支持用户通过集成阿里云SDK来完成API调用。在产品主页的 SDK 目录中，列举了云产品 SDK 支持的语言。您可根据实际业务需要的语言和集成方式将 SDK 引入到您的项目中。并且

在您使用 SDK 进行开发时，往往需要一些代码示例来辅助您进行开发。在 OpenAPI 门户中输入 API 请求参数的同时，会帮您生成 Java、PHP、Python、Node.js 等示例代码，以引导您进行开发。并且在对应语言的 SDK 页面，有 SDK 集成示例代码，帮助您快速完成集成工作。

集成CDK

阿里云资源编排（ROS）支持通过 CDK 定义资源，完成资源创建和配置，实现自动化部署及运维。 OpenAPI 门户提供 CDK 的集成调试、生成代码示例等。