yapi-to-api v1.1.3

generate-yapi-api

基于yapi自动生成api接口，支持ts

全局安装

npm i yapi-to-api -g

使用

// 1.查看版本号
yta -V

// 2.初始化
yta init

// 3.全局设置yapi 账号密码
yta set account

// 4.查看全局 yapi 账号密码
yta get account

// 5.生成 api 文件
yta generate api

yapiConfig配置

// init 之后参考模板配置
export interface IProjectConfig {
  /**
   * 生成ts 、js版本
   */
  target: 'ts' | 'js',
  /**
   * 项目id
   * 'http://122.51.157.252:3000/project/11/interface/api/20' projectId 对应 11
   */
  projectId: string,
  /**
   * 输出api文件路径。
   */
  outputFilePath: string,
  /**
   * 过滤需要比对的文件方法
   * currentGitBranch 当前git分支号
   */
  customizeFilter?:(api,options: {currentGitBranch}) => boolean,
  /**
   * 文件名称生成规则
   */
  generateApiName?: (path: string, _id: string | number) => string,
  /**
   * 自定义代码片段函数
   */
  generateApiFileTemplate?: (api: IOutPut) => string,
}

export type IYapiConfig ={
  /**
   * YApi 服务地址。
   * 'http://122.51.157.252:3000'
   */
  serverUrl: string,
  projectConfigs:IProjectConfig[]
}