P11：中台搭建3-RESTful API设计简介和路由配置

我们的所有数据的获得和业务逻辑的操作都是通过中台实现的，也就是说中台只提供接口，这里的设计我们采用RESTful的规则，让 egg 为前端提供 Api 接口，实现中台主要的功能。

RESTful 简介和约束方式

RESTful 是目前最流行的网络应用程序设计风格和开发方式，大量使用在移动端 App 上和前后端分离的接口设计。这种形式更直观并且接口也有了一定的约束性。

约束的请求方式和对应的操作。

• GET(SELECT) ： 从服务端取出资源，可以同时取出一项或者多项。
• POST(CREATE) ：在服务器新建一个资源。
• PUT(UPDATE) ：在服务器更新资源（客户端提供改变后的完整资源）。
• DELETE(DELETE) ：从服务器删除资源。

还有一些不常用的请求方式，因为不常用或者说我们的博客中用不到，所以我就不作过多的介绍了。

在 egg.js 中 Api 接口的路由配置

首先打开service根目录下的controller文件夹，在这个文件夹中新建两个文件夹admin（管理端使用的所有 API 接口）和default（客户端使用的所有 API 接口）文件夹。

目前我们只有客户端（前台）的页面，所以先在default目录下建立一个home.js文件，用于前台首页所需要的 api 接口。代码如下：

/service/app/controller/default/home.js

'use strict';

const Controller = require('egg').Controller;

class HomeController extends Controller {
  async index() {
    this.ctx.body = 'api 接口';
  }
}

module.exports = HomeController;

接口写好以后，我们需要配置一下路由。这里为了把路由也分成前后端分离的，所以在app文件夹下新建一个router文件夹。

在文件夹下新建两个文件default.js和admin.js。

default.js 文件

'use strict';
module.exports = app => {
  const { router, controller } = app;
  router.get('/default/index', controller.default.home.index);
};

router.js 文件

'use strict';

/**
 * @param {Egg.Application} app - egg application
 */
module.exports = app => {
  require('./router/default')(app);
};

编写好以后，我们使用npm run dev命令进行开启服务器，然后到浏览器中输入地址http://127.0.0.1:7001/default/index,如果能出现api 接口字样，说明已经完成了基本的路由设置。