Welcome to your Oenapi-To-Ts

Description

• 我们可以使用这个插件通过 OpenApi (Swagger Api Json) 生成Ts声明和Ts请求文件

所有的Commands

1. gen-complete-serviceTP:生成完整的ts类型声明与请求方法 生成一份完整的 service 文件
2. gen-simple-serviceTP:生成部分ts类型声明与请求方法 打开WebView自定义添加需要的路由

How to use it？

step1: 配置：Ctrl+, 打开用户设置，搜索OpenapiTots

1. 配置项 openapi-to-ts.OpenapiJsonUrl，配置 openapi 的 json url

   • 配置项格式 value 是一个标准的openApiJson的get资源
   • 也可以是本地json资源(需要放在当前工作区的根目录上)

     [
         {
           "label": "openapi",
           "value": "https://generator3.swagger.io/openapi.json"
         },
         {
           "label": "swagger",
           "value": "./swagger"
         },
     ]
     

2. 配置项 openapi-to-ts.requestLibPath，导入 request 函数的路径, 默认值 @utils/request

   • 如果 requestLibPath 为纯路径, 只会替换 requestLibPath 的内容
   • 如果 requestLibPath 包含 import, 会整体把导入语句替换

     import { request } from '${requestLibPath}'
     

3. 配置项 openapi-to-ts.serversPath 为生成的ts代码路径, 默认为 ./src/services

4. 配置项 openapi-to-ts.namespace 作用于生成的ts类型的声明文件的命令空间, 默认值为 API

5. 配置项 openapi-to-ts.serviceTemplate 配置请求函数的模板

   /** template1 */ 
   request.post(url, params/data, { headers, ...config})
   
   /** template2 */ 
   request.post(url, {data, params, headers, ...config})
   
   /** template3 */ 
   request(url, {method, data, params, headers, ...config})
   

6. 自行查看...

step2: 生成

1. 按Shift+Ctrl+p打开命令面板, 搜索 OpenapiToTs
2. 选择生成的命令
   • gen-complete-serviceTP:生成完整的ts类型声明与请求方法 生成一份完整的 service 文件
   • gen-simple-serviceTP:生成部分ts类型声明与请求方法 打开WebView自定义添加需要的路由