va-SwaggerTs-latest
使用方法
将swagger文档生成TS代码
- 点击"+"号创建一个[合约]. 在列表中会生成一条[合约]记录
- 点击[合约]右侧的"play"按钮, 会在指定的目录下生成TS代码
需要注意
- 生成代码时会清理指定的工作文件夹, 请确保此插件指定的文件夹没有其他代码.
- 插件会在根目录中生成.contractrc文件, 请勿删除或编辑该文件. 可能引起意料之外的BUG
- 插件只支持swagger 2.0的文档
打包注意事项
准备
发布
- 更新package.json中的version
- cd到项目根目录
- 执行 vsce package
- 得到vsix文件. 到上面的[插件管理]页面上传
项目说明
- out: 真正运行的代码在这里
- src/assets: 插件的各种图标在这里, 分为默暗主题和明亮主题
- src/generator
- code-template: 用来生成在 目标工程中的样版代码
- mocks: 收集一些典型的swagger-doc内容, 增加兼容性码
基础设置
设置工作目录
该目录指定了插件的工作目录, 插件生成的代码文件夹会以此目录为父目录. 因生成的代码会被业务代码引用, 所以请将其设置为项目原代码目录. (默认为: /src)
只能输入目录名称, 不支持path或pathLike内容.
2. 设置目标文件夹
该文件夹就是生成的代码存储的位置.
插件会生成一系列文件在此文件夹中, 生成之前会清除文件夹下的文件. 所以请确保此文件夹是专用的(即:不包含其他任何代码)
3. 文件描述
.1 request.ts文件
- 生成的文件中包含一个request.ts文件, 这个文件生成之后是不会再次生成的. 该文件提供基于合约接口的调用代码样版, 是可以根据实际情况修改的.
- 如果在执行生成合约的时候没有检测到request.ts文件, 则会再次生成一份样板代码
3.2 index.ts文件
- 该文件用于收集所有合约提供的方法, 统一收口向外导出
- 此文件在每次生成合约代码的时候都会被重写, 所以请不要修改此文件
3.3 types.ts文件
- 该文件主要为了解决定义为any或object会被tslint抛错的问题.
- 文件中定义的类型会被合约代码引用到, 所以也请不要修改
4. 常见问题
- 以Java定义的泛型类型Result为例, 如果T为null, Java是支持简便写法 Result的(等价于Result). 这个时候swagger会把它当作一个新的类型来生成. 那么在我们生成代码的时候会同时存在Result和Result这两个类型. 这时会类型冲突报错, 需要和后端沟通: 不要用这种简便写法
- 如果在使用过程中(已经生成过代码), 需要更换基础设置并重新生成代码, 请在点击[[更多设置]]中的[[初始化工程]]项. 该操作会检测当前的配置是否有对应的工作目录, 如果没有则从头生成
- 生成的ts 代码有可能不符合您当前项目的lint规则, 我们会在设置中逐步增加更丰富的配置项来作更好的支持.
| |
