自动化生成 Javascript 调用后台代码 v0.5.3 版本
这周,百家饭 OpenAPI 工具继续完善 0.5.3 版本的开发工作,继续进行 Javascript 脚本的自动生成研发,经过这周的研发,百家饭的 OpenAPIJavascript 代码自动生成功能终于开始在自己平台上用起来了,前期 4 个接口的生成脚本在代码格式、注释内容和基础 required 鉴权等方面达到了初步的要求。
Javascript 生成脚本完成了以下一些功能的优化。
1)当输入参数为空时,不进行默认参数覆盖原来默认都会生成一个默认参数,以方便用户设置某些入参的默认值,就像这样:
当没有配置任何默认参数时,看着就很别扭,自己都看不过去了,这周把这个去掉,如果用户没有配置任何默认参数的话,这个空的 defaultParam 就不再生成了。
2)支持对于较少数量参数的请求,直接将参数展开,不是传递 object 的模式,该配置可以通过配置为某一个函数设置特殊模式 0.5.2 版本的时候,所有的参数调用都是 object 格式,比如这样
那如果要登录的话,需要传入的参数是:
有时候一些简单的调用,这么传输就比较费劲,对于少量入参的函数,就直接把参数扩展出来就好了,变成类似这样:
3)支持 commonjs 和 es6 两种引用模式。支持 require 和 import 两种模式,模式可以通过附加-Dcommonjs=true(或者 false)进行配置。
4)去除对于不需要的类库的引用百家饭 OpenAPI 支持公式参数,一些费劲的 API 各种 sign 什么的,可以公式直接生成,js 代码使用的话就会引用外部依赖库,比如 md5,dayjs 之类,但是这些对于普通使用者,如果没用到就也要引用的话就显得很麻烦,这一版会根据用户使用情况再决定是否生成对应的函数和引用,普通使用的话,就不会有很多依赖的情况了。
5)默认不再设置 baseUrl 的 host 一般 OpenAPI 文档都是带域名的,比如这样:
主要是因为 OpenAPI 所规定的 API 是公开使用的,不限于前后台交流,但是 Javascript 一般调用的都是本网站的后端接口,这次,针对 JS 的代码生成,我们就默认去掉 baseURL 中的 host。默认改成这样:
支持 URL 参数很多接口都会用到 url 参数,比如 url 中某一段是 id,或者像我们一样,是个表示返回类型的字段
}
我们用到了 java 的 template string 来将传入参数设置到 url 里面。
完成这些步骤之后,我们自己研发的产品终于自己平台先用上了,希望尽快可以让大家试用百家饭的 JS API 调用代码自动生成功能,整体预计和客户端软件 0.5.3 版本下周一起发布,希望能够对大家的日常开发有用。
版权声明: 本文为 InfoQ 作者【百家饭隐私计算平台创业者】的原创文章。
原文链接:【http://xie.infoq.cn/article/8b1b5e14152f1d9c8ce4efb3b】。文章转载请联系作者。
评论