api-laird
v1.0.8
Published
api生成工具
Downloads
3
Readme
说明文件
src 文件夹: api请求核心代码 src/tools 文件夹: 解析swagger接口文件 生成ts📃文件
TypeScript of Swagger Api
npm i api-swag-core
Notice
1.此工具目前只是使用部分
2.生成代码的部分暂时未提交
3.如果有需要的话可以提供给大家
Use
import API from 'api-swag-core';
// Role 表示角色模块
// getList 表示请求角色列表
API.Role.getList().then(res = > {});
Init
一个使用TypeScript自动解析集成Swagger接口的🔧
1. 生成ts接口文档 /generate
2. 核心导出文件 /core
Other
通常前端要定义一大堆接口来进行调用
一旦后台的参数变更或者调整 前端则要手动修改
然后 我们可以有一个工具
1. 自动解析后台的接口 包括: url 请求方式 入参 出参
2. 根据后台的controller生成不同模块的ts接口文档
3. 构建一个类 里面包含了每个controller的方法
4. 最重要的一步:他是自动构建出来的不需要手写 每次自动更新获取
5. 这以后应该是前端的标配工具了
All
1. 我们不需要再手动写定义接口的代码
2. 根据生成的文档 我们可以根据代码提示 调用方法 传入参数