2.0.6 • Published 4 months ago

nei-api v2.0.6

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

nei-api

基于 NEI 自动化生成 API 模拟数据和接口 SDK。只需一行命令,快速生成前端所需要的接口文件和 mock 数据!

安装

$ npm install nei-api -g

用法

同时生成接口文件和 mock 数据:

$ nei-api all

只生成 api 接口:

$ nei-api api

只生成 mock 数据:

$ nei-api mock

开启 mock 服务:

$ nei-api start

通过 AIGC 问答的方式修改指定路径下的 mock 数据:

$ nei-api ask /mock/xxx/xx.json "list返回10条不一样的数据"

配置

在项目的主目录下新建 nei.config.js 文件,配置内容如下

const cwdPath = process.cwd();
module.exports = {
  // 获取json文件的方式 1-本地获取 2-http获取
  TYPE: 1,
  // api.json文件本地路径
  API_FILE_PATH: `${cwdPath}/api.json`,
  // api 生成路径
  API_DIR_PATH: `${cwdPath}/src/services/`,
  // mock 生成路径
  MOCK_DIR_PATH: `${cwdPath}/mock/`,
  // api模板路径
  TPL_API_PATH: `${cwdPath}/tpl/@api/module.js`,
  // 自定义request本地路径
  REQUEST_PATH: "@/utils/request/request",
  // NEI数据源服务器
  NEI_SERVER: "https://nei.netease.com",
  // NEI项目ID(支持多项目配置)
  NEI_PID: "123,456",
  // NEI访问令牌
  PRIVATE_TOKEN: "xxxx",
  // 项目组的唯一标识 Key,在项目组的设置中查看
  PROGROUP_KEY: "xxxx",
  // OPENAI接口地址
  OPENAI_URL: "https://xxxx.com",
  // OPENAI官方提供的Api-key
  OPENAI_API_KEY: "xxxx",
  //由网易杭研内部系统提供的APP_ID,在console.openai.163.com中查看
  NETEASE_APP_ID: "xxxx",
  //由网易杭研内部系统提供的APP_KEY,在console.openai.163.com中查看
  NETEASE_API_KEY: "xxxx",
  // 项目关键词,可影响mock数据的生成(推荐用英文描述)
  PROMPTS: ["Contains information about the enterprise"],
};

配置参数说明

名称类型是否必需说明
TYPEInt获取 json 文件的方式 1-本地获取 2-http 获
PRIVATE_TOKENStringNEI 访问令牌
PROGROUP_KEYString项目的唯一标识 Key,在项目的设置中查看
REQUEST_PATHString自定义 request 本地路径
NEI_PIDStringNEI 项目 ID(如果是多个,必须是同一个项目组里的)
API_FILE_PATHStringapi.json 文件本地路径
API_DIR_PATHStringapi 生成路径
MOCK_DIR_PATHIntmock 生成路径
TPL_API_PATHStringapi 模板路径
NEI_SERVERIntNEI 数据源服务器
OPENAI_URLStringOPENAI 接口地址,目前支持官方地址(需要填写 OPENAI_API_KEY)和网易杭研地址(需要填写 NETEASE_APP_ID 和 NETEASE_API_KEY)两种方式
OPENAI_API_KEYStringOPENAI 官方后台提供的 Api-key
NETEASE_APP_IDString由网易杭研内部系统提供的 APP_ID,可在网易 AI 平台中查看
NETEASE_API_KEYString由网易杭研内部系统提供的 APP_KEY,在网易 AI 平台中查看
PROMPTSString项目关键词,可影响 mock 数据的生成(推荐用英文描述)
2.0.6

4 months ago

2.0.5

5 months ago

2.0.4

6 months ago

2.0.0-alpha.7

12 months ago

2.0.0-alpha.8

12 months ago

2.0.0-alpha.9

11 months ago

2.0.3

9 months ago

2.0.0-alpha.11

11 months ago

2.0.0-alpha.3

12 months ago

2.0.0-alpha.10

11 months ago

2.0.0-alpha.4

12 months ago

2.0.0-alpha.5

12 months ago

2.0.0-alpha.6

12 months ago

2.0.0-alpha.1

12 months ago

2.0.0-alpha.2

12 months ago

2.0.1

11 months ago

2.0.0-alpha.13

11 months ago

2.0.0

11 months ago

2.0.0-alpha.12

11 months ago

2.0.0-alpha.0

12 months ago

0.1.5

3 years ago

0.1.4

3 years ago

0.1.3

3 years ago

0.1.2

3 years ago

0.1.1

3 years ago

0.1.0

3 years ago

0.0.9

3 years ago

0.0.8

3 years ago

0.0.7

3 years ago

0.0.6

3 years ago

0.0.5

3 years ago

0.0.4

3 years ago

0.0.3

3 years ago

0.0.2

3 years ago

0.0.1

3 years ago