vscode插件开发之Swagger生成Ts

置顶

不辞冰雪-lzl

已于 2022-11-23 18:21:06 修改

阅读量2.9k

点赞数 2

文章标签： javascript 前端 typescript vscode webview

于 2022-11-23 18:17:52 首次发布

本文链接：https://blog.csdn.net/a1196324866/article/details/128004291

版权

本文介绍了如何开发一个VSCode插件，该插件能根据Swagger接口文档自动生成TypeScript类型定义和服务代码。利用openapi-typescript解析JSON，通过recast构造AST并写入文件。此外，文章还详细讲解了如何实现Webview与VSCode的交互，包括处理本地资源加载和通信。最后，作者分享了项目的源代码链接，邀请读者试用并提供反馈。

摘要由CSDN通过智能技术生成

vscode插件开发之Swagger生成Ts

当后端同学给到我们Swagger接口文档的时候，是不是在为要写接口类型烦恼，为了偷懒，那么就any吧。any一时爽，同事泪两行。为了高质量的偷懒，来开发个插件leizl.swagger-generate-ts。

日常案例

摆在我们前面的有一份接口平台地址和我们需要用到的接口名称。日常开发中我们一般需要做以下事情。
写一份类型声明文件xx.d.ts

export interface PropertyValueAddRequest {
   
  /**
   * Format: int64
   * @description 属性Id
   */
  propId?: number;
  /** @description 属性值列表 */
  propValueList?: string[];
}

export interface ApiResultboolean {
   
  code?: string;
  data?: boolean;
  msg?: string;
  success?: boolean;
  traceId?: string;
}

写一份service请求代码

import {
    post } from '@/utils/request';
import {
   
  PropertyValueAddRequest,
  ApiResultboolean,
} from '@definitions/gmp-product-library-portal/library/manage/property';

export function addPropValue(
  data: PropertyValueAddRequest,
): Promise<ApiResultboolean> {
   
  return post(
    `/gmp-product-library-portal/library/manage/property/addPropValue`,
    data,
  );
}