Swagger-TypeScript-API通过Swagger方案生成TypeScript API代码
swagger-typescript-api 的 TypeScript API 生成方式,适合用 Swagger/OpenAPI 规范定义接口的项目。支持 OpenAPI 3.0/2.0,JSON 或 YAML 格式都行,兼容性还挺不错。你只要把接口文档路径扔进去,它就能自动生成求代码,连求方法都封装好了,基本能直接用。
支持命令行操作也方便,比如:
swagger-typescript-api -p ./swagger.json -o ./api -n index.ts
这行代码一跑,index.ts
就能自动生成出来,接口方法都有注释,调用也直观。
版本 > 4.0.0 之后还支持自定义 mustache 模板,你可以按自己项目风格定制生成代码的样子。嗯,这点对追求统一代码风格的人来说挺实用。
官方了不少例子,支持各种格式和场景的 Swagger 文件。响应也快,基本上你一保存 Swagger 文档,代码就能自动同步生成。
如果你常用 OpenAPI 来写接口定义,或者想省点手写代码的力气,这工具真挺值一试的。哦对了,还有不少同类工具可以一起参考着看:
- openapi-typescript:只生成类型,适合类型优先的项目
- Swaxios:封装 Axios 的客户端生成器,结构清晰
- yapi-to-typescript:支持 YApi 和 Swagger,适配性还不错
如果你对自动化代码生成感兴趣,可以试试配合 husky
或 lint-staged
做提交前更新,省事又省心。
swagger-typescript-api:通过Swagger方案的TypeScript API生成器
预估大小:206个文件
.all-contributorsrc
4KB
procedure-call.eta
2KB
route-docs.eta
1KB
route-name.eta
1KB
data-contracts.eta
689B
http-client.eta
5KB
route-type.eta
772B
procedure-call.eta
2KB
route-docs.eta
1KB
route-name.eta
1KB
8.68MB
文件大小:
评论区