网易NEI接口管理使用

NEI网址

NEI使用文档

1. 注册完进入NEI界面是下面这样的:


网易NEI接口管理使用_第1张图片
NEI界面

2. NEI 工程规范介绍

3. NEI传给模板的数据说明

4. Handlebars 辅助函数集说明

5. NEI 按项目来管理所有资源,资源的创建和维护可由团队成员协作完成,目前它已经提供了以下功能:

项目管理:动态、团队管理、权限管理、项目文档等

页面管理:项目中的页面定义

异步接口:即本文所说的 API,可以定义请求头、请求数据、发送规则、响应头、响应结果、接收规则等

接口测试和用例管理:方便回归测试和生成测试代码

数据模型:NEI 中最强大的功能之一,对应数据库中的实体对象

页面模板:NEI 配套的构建工具会根据定义生成模板文件

规则函数:自定义 MOCK 数据,NEI 也预置了常见的规则函数

业务分组:按照业务对项目资源进行细分,方便管理

工程规范:本身可以当作脚手架,也可以和 NEI 项目结合,集成项目中的 API 和数据模型

消息中心:保证重要的操作能及时通知到相关负责人

下面是几篇介绍文章:

使用 NEI 进行前后端并行开发

老项目迁移到 NEI 上的说明

一步一步教你如何愉快地生成 JavaBean 文件

以上所有文章都放在 Github 仓库的 doc 目录下:NEI 配套构建工具


6. 开发步骤

(1)登陆NEI,点击左边的项目管理,选择一个项目进入。

(2)在已建好的NEI项目中,制定一个工程规范,如下图所示:

网易NEI接口管理使用_第2张图片

如果需要使用接口的Mock服务的话,需要指定一个接口MOCK数据根路径, 如下图所示:


网易NEI接口管理使用_第3张图片

(3)使用平台配套自动化工具

(4)如此操作之后,大家就可以通过以下命令生成 TodoWeb 项目:

nei build -k 717a630f6033dfe235c73a4e6dac16e3 -o ./todoweb

(5)然后运行下面的命令启动本地模拟容器:

nei server -k 717a630f6033dfe235c73a4e6dac16e3 -o ./todoweb

(6)此时会自动打开浏览器,并会列出 TodoWeb 项目可以访问的页面地址。

点击index页面,打开的是空白页面,大家可以试着修改 view 或者 view 中引入的 javascript 代码,此时定义的所有异步接口都是可以调用的。 如果需要单独访问异步接口的话,比如说GET /api/todos这个接口,就可以在浏览器中直接访问http://localhost:8002/api/todos(假设nei server分配到的端口是8002),该接口的mock数据就能展现出来了。

7. NEI与阿里RAP的优势

NEI 比 RAP 多了一些功能,我个人觉得 NEI 的数据模型概念是最强大的(更接近开发的真实场景),RAP 没有提供。其他NEI特有的功能还有:提供配套的构建工具(集成了本地模拟容器)、接口测试(NEI通过浏览器插件的形式,可以直接测试 localhost 的本地接口)、工程规范(本身可以作为脚手架,和NEI项目结合功能更加强大,能生成项目的初始目录结构,并且可以集成NEI上面定义好的资源)、自定义mock数据(可以自己写js脚本)等

你可能感兴趣的:(网易NEI接口管理使用)