guandata-api-generator README

Guandata Frontend 数据服务层解决方案

Features

可自动生成 EoLink 平台已定义好的接口分类，在本地生成对应的请求体、响应体定义和请求函数文件

Requirements

1. 安装 VSCode 插件: Guandata Api Generator
2. 在EoLink API管理平台有对应的API分组，分组名需为 中文名(英文名) 或 英文名,如 登录设置(login-setting) 或 login-setting，英文名将作为生成的文件名及分组namespace名称
3. CMD+SHIFT+P 打开VSCode控制面板, 输入 Pull Api 命令, 回车确定
4. 选择需要拉取的分类，回车即可生成

Other

支持接口类型

• 请求体: SearchParam、RestfulParam、JSON
• 响应体: JSON
• 暂不支持生成文件上传/下载等特殊结构体的接口
• 结构体(EoLink上提前定义的数据结构)支持正在开发中, 请暂不要在参数/返回值中使用

RAW请求

• 生成的请求函数默认使用项目中的secureFetchGet/secureFetchPost, 若希望使用 fetchGet/fetchPost, 需给该api增加 PROXY 标签

Known Issues

• 因不同项目使用的请求函数不同, 插件目前只支持BI项目(guandata-web)