写点什么

Javascript API 自动代码生成需求征集

  • 2022 年 6 月 17 日
  • 本文字数:894 字

    阅读完需:约 3 分钟

百家饭平台的 OpenAPI 编辑功能已经初步完成一段时间了。详细的功能介绍见(使用百家饭API编辑器定义接口 | 百家饭隐私计算平台 (rongapi.cn)

在那之后,百家饭团队为了提升 OpenAPI 的适用性,针对疫情情况下的复杂开发环境,未具有 Swagger 的后台开发者,推出了 API 网关功能,帮助将开发环境开发给在任何地方开发的前端,居家办公怎么调试API? | 百家饭隐私计算平台 (rongapi.cn)

目前希望进一步往下开展的工作围绕调用方进行,因为 OpenAPI 的标准化程度还是非常高,非常丰富的标准化属性,我们认为可以尝试进行 OpenAPI 定义向标准代码翻译的工作,以往有一些开源软件也进行了相关的一些探索,这样我们可以站在前人的一些探索的基础上,加入目前最新的业界的一些变化(更重要的是,加入中文的注释), 构建新的代码生成工具。

第一种适配语言选择 Javascript,因为在现在前后端分离的情况下,调用 API 的主要开发就是前端开发人员,也为我们自己的前端开发减轻一些压力。选择的调用框架是 axios,初步设计输出为同一目录下的多个文件,结构如下:

axios目录|- axios.js export文件 |- config.js 配置文件 |- api-aaa.js 调用逻辑,接口aaa |- api-bbb.js 调用逻辑,接口bbb |- ....
复制代码


所有文件放到同一目录下,方便开发人员进行进一步的版本管理,里面包括

  • 一个入口文件,用于 export

  • 一个配置文件,包括服务器选择,服务器参数等,选中的作为代码,其他作为注释,开发人员可通过注释选择。

  • 每个接口(OpenAPI 中的 Path)生成一个文件,而每个 method 作为一个函数,例如 aaa 接口的 get 方法生成 getAaa 函数。

  • 对入参和出参按配置生成检查函数,包括必要性检查、正则表达式规则检查等。类型检查等放到 Typescript 版本的时候再来完成。

这些就是初步的设计逻辑,我们会把模板文件开源在 gitee.com,仓库地址是

openapi-client-template: 百家饭隐私计算平台,OpenAPI调用客户端生成工具所使用的各语言模板 目前进展:Javascript进展中 (gitee.com)

欢迎通过 Issues 提交您的想法,需求。

还有一点我要说明的是,OpenAPI 在 Swagger 的基础上发展至今,已经到了 v3.2.0 版本了,相关定义都是标准化的,因此,百家饭的生成器之后也可以配合其他 OpenAPI 编辑器使用。

发布于: 刚刚阅读数: 2
用户头像

低代码API对接+隐私计算 2022.06.06 加入

通过低代码工具完成API对接,结合多方计算技术实现API的隐私计算。本号主要发布创业过程中的其他相关故事,技术探索。主要创业故事见知乎或微信"百家饭隐私计算"号 https://rongapi.cn

评论

发布
暂无评论
Javascript API自动代码生成需求征集_JavaScript_百家饭隐私计算平台创业者_InfoQ写作社区