您可以通过Darabonba语言更好的描述OpenAPI ,其具备兼容多网关、描述任意风格的OpenAPI,并且可通过编写Darabonba的文件自动化生成多语言的SDK。本文介绍如何创建属于自己的OpenAPI SDK示例(即CodeSample)。
步骤一:创建CodeSample
项目
登录OpenAPI 门户。
在顶部导航栏,选择
。在左侧导航栏选择我的贡献,然后单击创建CodeSample。
在创建CodeSample页面输入CodeSample标题和CodeSample概要信息描述,单击初始化CodeSample。
在完成创建页面,已经创建了CodeSample相关的三个文件(
Darafile
、main.dara
、README.md
)。Darafile
文件Darabonba
的项目文件,通过libraries
字段引入模块,如下示例引入了Console模块。main.dara
文件Darabonba脚本主要描写文件,可以生成各语言的CodeSample,初始化的文件中有一段可以生成各语言的初始代码,单击编辑代码图标即可编辑,编辑完成后单击页面下方的提交修改按钮即可保存。
README.md
文件项目的描述文件,通过Markdown的语法书写即可。
上述三个文件的编辑完成后,单击生成不同语言代码来生成多语言的CodeSample。
等待生成完成后,即可通过导航栏上的语言页签切换查看各语言生成的结果,如果生成失败会生成对应的
error.log
文件。
步骤二:调试代码
不同语言代码生成以后,需要调试运行来确定各语言生成的代码是否正确,避免提交审核后被拒绝。
选择Darabonba页签,单击配置调试参数。
在配置调试参数面板中输入参数名称、参数描述、默认值,单击保存。
修改Darabonba页签中的
main.dara
文件,代码中做如下修改来使用传入的参数。修改完成后,单击生成不同语言代码按钮重新生成各语言的代码。
单击各语言页签中的运行调试,调试各语言生成的代码。
在CloudShell的弹窗中,自动完成依赖安装和代码编译后,执行命令行里自动写入的语句即可完成调试。
步骤三:提交审核
在各语言代码运行调试通过后,单击页面右上方的提交审核,将写好的CodeSample项目提交审核。
在左侧导航栏选择我的贡献,即可看到审核状态的
CodeSample
项目。如果审核不通过,则会在审核拒绝页签中看到
CodeSample
项目拒绝的原因。审核通过后,贡献的
CodeSample
项目会出现在阿里云 OpenAPI 开发者门户的示例中心,成为广大开发者学习和使用的对象。