背景
新进了一家初创公司,啥也没有,所有东西都得从头开始进行基建。 我们平时和后端对接接口的时候都需要根据后端提供的接口文档来再写一遍调用接口的方法,十分的繁琐和无意义,对技术的提高也没有任何帮助。
感谢工作的第一家公司,技术大佬写了一个根据OpenAPI3规范生成前端TS模型和接口调用方法的脚本,十分便捷,后端提供一份符合OpenAPI3规范的Swagger JSON就可以一键生成,使得平时开发工作从繁琐的类型定义和模型定义以及接口方法书写重复劳动中解脱出来,类型即文档,堪称anyscript到typescript的蜕变,给我留下了深刻的印象。
进到新公司后,需要从头开始基建,萌生了自己写一个的想法。
写法对比
很多时候我们是这样来手写代码调用接口的:
自己写路径、方法类型,繁琐重复

现在我们写一个脚本,根据后端给的Swagger JSON直接生成这些接口调用方法和类型:
模型和接口方法都是生成的,不需要自己写,节省大量重复劳动


调研
由于还有业务需要写,所以工具类不能放太多时间, 我就调研了市面上根据OpenAPI规范生成ts代码的库想拿来适配一下。查了一些库,不太合适,有的太庞大了,不方便修改,想起来

本文讲述了作者在新公司面临的接口开发繁琐问题,忆起之前工作中使用的OpenAPI3规范生成工具。作者调研后决定自定义脚本,根据SwaggerJSON生成TypeScript模型和接口方法,实现接口自动化,并针对团队需求进行了调整,如使用类和静态方法、泛型以及APIFOX的适配。
最低0.47元/天 解锁文章
2167





