框架 f-ext-base

框架如何启动

• 修改 micro-service 下各微服务目录中 package.json，以 f-ext-base 为例

  egg: {
      …,
      "framework": "f-ext-base"
  },
  dependencies: { 
      ..., 
      "f-ext-base": "../../extend/framework/f-ext-base"
  }
  

• npm i
• npm link ../../extend/framework/f-ext-base

框架目录

. egg-framework
├── package.json
├── app.js (可选)
├── agent.js (可选)
├── app
│  ├── service (可选)
│  │   └── user.js
│  ├── middleware (可选)
│  │   └── response_time.js
│  ├── schedule (可选)
│  │   └── my_task.js
│  ├── public (可选)
│  │   └── reset.css
│  ├── view (可选)
│  │   └── home.tpl
│  └── extend (可选)
│       ├── helper.js (可选)
│       ├── request.js (可选)
│       ├── response.js (可选)
│       ├── context.js (可选)
│       ├── application.js (可选)
│       └── agent.js (可选)
├── lib (可选)
│  ├── framework.js (可选)
│  ├── plugin (可选)
│  │   └── egg-xxx.js
├── config
│  ├── plugin.js
│  ├── config.default.js
│  ├── config.prod.js
│  ├── config.test.js (可选)
│  ├── config.local.js (可选)
│  └── config.unittest.js (可选)
└── test
    ├── middleware
    │  └── response_time.test.js
    └── controller
        └── home.test.js

框架和插件中配置中间件

# {root}/app.js
"use strict";

module.exports = (app) => {
  // 框架或插件中配置中间件
  app.config.coreMiddleware.unshift("compress");
};

接口文档

apidoc 生成接口文档

• 安装

  cnpm install apidoc -g
  

• 使用

  apidoc -i app/routes/ -o apidocs/ -f ".*\.jsquot;
  
  或
  
  npx apidoc -i app/routes/ -o apidocs/ -f ".*\.jsquot;