openapi3-typescript v0.0.2

openapi协议解析

通过解析远程或者本地的openapi的json文件信息,生成供接口使用的返回值ts类型 目前仅支持 openapi3协议 的 post请求解析

export type Modal = {
  /**
   *
   */
  "post/user/updateById": {
    req: {
      /**
       * ID
       */
      id: number;

      /**
       * 用户名
       */
      name: string;

      /**
       * 年龄
       */
      age: number;

      /**
       * 性别 1:男  2:女
       */
      gender: number;

      /**
       * 头像
       */
      avatar: string;

      /**
       * 创建时间
       */
      createTime: string;

      /**
       * 修改时间
       */
      updateTime: string;
    };
    res: {
      /**
       *
       */
      code: number;

      /**
       *
       */
      msg: string;

      /**
       *
       */
      data: {
        /** ID */ id: number;
        /** 用户名 */ name: string;
        /** 年龄 */ age: number;
        /** 性别 1:男  2:女 */ gender: number;
        /** 头像 */ avatar: string;
        /** 创建时间 */ createTime: string;
        /** 修改时间 */ updateTime: string;
      };
    };
  }
}

安装

pnpm i  openapi3-typescript -D

生成

远程openapi

执行

openapi3-typescript http://localhost:8080/v3/api-docs/default

本地openapi

openapi3-typescript openapi.json

使用

const result:Modal["post/user/updateById"]["res"]  = await axios.post("http://localhost:8080/user/updateById")

更新日志

0.0.1 发布使用