1. 自定义API

路由定义 .router.js

  • 文件名称必须以 .router.js 结尾, 比如: xxx.router.js
  • 文件必须使用 exports.default 导出一个 express.Router 的实例

简单路由示例

  const express = require("express");
  const router = express.Router();

  router.get('/my/api/test', async function (req, res) {
      res.status(200).send({message: 'test ok'});
  });
  exports.default = router;

需登录认证的路由示例

  • 认证处理器: core.requireAuthentication, 认证成功, 则可以在req中获取到当前用户信息req.user ; 认证失败, 则会返回401错误
const express = require("express"); 
const router = express.Router(); 
const core = require('@steedos/core');
router.get('/my/api/need_auth', core.requireAuthentication, async function (req, res) { 
    res.status(200).send({ message: 'test ok' }); 
}); 
exports.default = router;

创建 router 文件

  • 1、打开命令面板,在输入框中输入“Steedos:”,则会出现可选的命令列表,选择“Create Router”

  • 2、输入router 文件名称,输入回车

  • 3、选择将要生成的目录

  • 4、生成的router文件内容如图所示