yapi-to-zod README

vscode插件，通过yapi接口返回的数据生成zod接口定义文件

Features

使用

1、配置Yapi帐号信息

在设置=>扩展=>Yapi To Zod中配置yapi帐号信息

2、生成配置文件

使用快捷键F1或cmd/ctrl+shift+p调出命令窗口，输入YapiToZod， 选中YapiToZod: 生成配置文件命令。

配置文件.yapi-to-zod.js内容：

module.exports = () => {
	return {
		/** 头部内容，可以填写导入的请求实例等 */
		header: [],
		/**
		 * 生成请求内容
		 * @param {object} param0
		 * @param {string} param0.comment 注释内容
		 * @param {string} param0.interfaceName 接口名，大驼峰
		 * @param {string | undefined} param0.reqModelName 请求参数模型名
		 * @param {string | undefined} param0.resModelName 返回数据模型名
		 * @param {string} param0.apiPath 接口路径
		 * @param {string} param0.resource 微服务名称
		 * @param {object} yapiData 接口数据
		 */
		genRequest(
			{ comment, interfaceName, hasReqDefine, hasResDefine, apiPath },
			yapiData,
		) {
			//
		},
	};
};

3、生成接口声明文件

在目录中右键选择YapiToZod：生成Api声明文件命令

填入接口路径，回车创建接口声明文件