生成SDK与文档

完成API开发与设计后,您可以在控制台一键生成SDK及其使用文档,简化了API的使用和集成,无论是内部的前后端联合开发,还是对外提供的API服务,都无需编写任何额外的代码来调用API。

前提条件

已完成API创建并添加接口。具体操作,请参见创建REST API并添加接口

操作步骤

  1. 登录云原生API网关控制台

  2. 在顶部菜单栏选择地域,在左侧导航栏,单击API管理

  3. 在API列表中,选择目标API,选择页面右上角更多操作 > SDK&文档生成

  4. SDK&文档生成对话框中,选择相关参数,然后单击生成并下载

    配置项

    说明

    API版本

    选择要生成SDK与文档的API版本。

    说明

    若创建API时未启用版本管理,则无该选项。

    SDK语言

    目前支持的SDK语言:Java、Golang、Python、Node.js、TypeScript、Swift。

  5. 等待生成SDK及相关文档后,浏览器将自动下载SDK及相关文档的压缩包至您的本地计算机,您可以到浏览器默认下载路径中进行查看。

    说明

    解压完成后,您可以参考README.md文档作为SDK的使用指南,该文档包含了使用SDK所需的基本信息。