midway Documentation

import { Controller, Get, Provide } from '@midwayjs/decorator';

@Provide()
@Controller('/')
export class HomeController {

  @Get('/')
  async home() {
    return `Welcome to midwayjs!`;
  }
}

import {
  Api,
  Get,
  Query,
  useContext,
} from '@midwayjs/hooks';

export default Api(
  Get(),
  Query<{
    page: string;
    limit: string;
  }>(),
  async () => {
    const ctx = useContext();
    return {
      page: ctx.query.page,
      limit: ctx.query.limit,
    };
  }
);

import getArticles from './api';
const response = await getArticles({
  query: { page: '0', limit: '10' },
});
console.log(response); // { page: '0', limit: '10' }

fetch('/api/articles?page=0&limit=10')
  .then((res) => res.json())
  .then((res) => console.log(res)); // { page: '0', limit: '10' }

$ npm -v

## 选择模版
$ npm init midway

## 进入项目路径
cd my_midway_app && npm run dev

$ ./ready.sh
$ node index

Waiting for Midway 3 with request context to initialize...
Running benchmark on Midway 3 with request context...
Midway 3 with request context QPS:  2374.4
Waiting for Midway 3 with async hooks to initialize...
Running benchmark on Midway 3 with async hooks...
Midway 3 with async hooks QPS:  2495.81

$ npm i @midwayjs/view-ejs --save

import { Configuration } from '@midwayjs/core';
import * as view from '@midwayjs/view-ejs';
import { join } from 'path'

@Configuration({
  imports: [
    // ...
    view
  ],
  importConfigs: [
    join(__dirname, 'config')
  ]
})
export class ContainerLifeCycle {
}

// src/config/config.default.ts
export const view = {
  defaultViewEngine: 'ejs',
  mapping: {
    '.ejs': 'ejs',
  },
};

// ejs config
export const ejs = {};

import { Inject, Provide } from '@midwayjs/core';
import { Context } from '@midwayjs/koa';

@Controller('/')
export class HomeController {

  @Inject()
  ctx: Context;

  @Get('/')
  async render(){
    await this.ctx.render('hello.ejs', {
      data: 'world',
    });
  }
}

// src/config/config.default.ts
export const view = {
  mapping: {
    '.ejs': 'ejs',
    '.nj': 'nunjucks',
  },
};

await this.ctx.render('user.nj');

// lib/view.ts
import { Provide } from '@midwayjs/core';

@Provide()
export class MyView {

  @Config('xxxx')
  viewConfig;

  async render(fullpath, locals) {
    return myengine.render(fullpath, locals);
  }

  async renderString() { throw new Error('not implement'); }
};

// src/configuration.ts
import { Configuration, Inject, Provide } from '@midwayjs/core';
import * as koa from '@midwayjs/koa';
import * as view from '@midwayjs/view';
import { MyView } from './lib/my';

@Configuration({
  imports: [koa, view],
  importConfigs: [join(__dirname, 'config')]
})
export class AutoConfiguration {

  @Inject()
  viewManager: view.ViewManager;

  async onReady(){
    this.viewManager.use('ejs', MyView);
  }
}

export default appInfo => {
  const appDir = appInfo.appDir;
  return {
    view: {
      rootDir: {
        default: `${appDir}/view`,
        anotherDir: `${appDir}/view2`
      }
    }
  }
}

// src/config/config.default.ts
export const view = {
  defaultExtension: '.html',
};

// controller
import { Inject, Provide } from '@midwayjs/core';
import { Context } from '@midwayjs/koa';

@Controller('/')
export class HomeController {

  @Inject()
  ctx: Context;

  @Get('/')
  async render(){
    // render user.html
    await this.ctx.render('user');
  }
}

// config/config.default.js
export const view = {
  defaultViewEngine: 'ejs',
};

npm i
# dev site in docs
npm run dev
# run build
npm run deploy
git commit -m "docs:add site"
git push origin master

<nav>
      [使用文档](https://www.yuque.com/midwayjs/midway_v2)
      [示例库](http://demo.midwayjs.org/)
      [API](/api-reference/index.html)
      [Node 地下铁 Club](https://subway.midwayjs.org)
      [备用文档](start_app.html)
    </nav>
    
  




  
    一个面向未来的
    云端一体 Node.js 框架
    Midway 是一个适用于构建 Serverless 服务，传统应用、微服务，小程序后端的 Node.js 框架
  
  
    
      <a class="home-top-button button view" href="https://www.yuque.com/midwayjs/midway_v2">访问文档</a>
      
      
      
    
    <a class="home-top-button button white" href="https://github.com/midwayjs/midway">源码</a>
  




  Midway Serverless 2.0
  全新的一体化方案
  全新的 Serverless 测试方案
  业界首创的全栈开发方式
  我们的发布会已结束，可以扫描右侧二维码观看回放
  
    
      
      bilibili 前端圈（直播回放）
    
     
      
      Node.js 地下铁
    
  




  不论你在寻求何种解决方案，
  Midway 总能提供给你最适合的那一个
  
  
  
  <a class="home-solution-more button" href="http://demo.midwayjs.org/">查看所有解决方案</a>
  
    
      <a class="ad-middle-button button white" href="http://d2forum.alibaba-inc.com/" target="_blank">点击报名</a>
    
    
      <a class="ad-middle-button button white" href="https://mudu.tv/watch/7560584">了解更多</a>
    
  




  为什么选择 Midway?
  
    Serverless 应用云端一体
    Midway 不仅提供了和各个前端框架结合的能力，在传统的开发基础上，更增加了一体化研发模式，让前端业务能够更自如的调用 Node.js 代码，开发的更快更简单。
    
  
  
    代码复用和组件化能力
    Midway  不仅抽象出了满足不同场景的上层框架，也提供了跨场景复用的组件化能力，甚至还提供了业务代码的复用组件 ，让业务代码可以轻量化的拷贝和分享到不同的场景应用。
    
  
  
    一份代码，多场景部署
    Midway 提供了一套完整的解决方案，只需要写一次代码，就可以自动构建出适合于传统应用 ，微服务，乃至 Serverless 环境的代码包 ，方便用户移植程序到不同的部署环境。
    
  
  
    高并发业务稳定高效
    Midway 在 阿里集团内部已经普遍使用，经过了多次大促的洗礼，整个框架已经非常高效和稳定。默认情况下， Midway 在 Web Application 开发时提供了非常多的内置能力，用户无需再去查询其他能力。
    
  




  加入我们
  MidwayJs 是一个开源品牌，旗下的产品都为 MIT 协议，欢迎各位提交代码 ，一起共建 Node.js 生态。
  




  
    © 2021 ~ ∞ Midwayjs@Serverless
    <a class="link" href="https://github.com/midwayjs/midway">Github</a>
    <a class="link" href="https://github.com/midwayjs/midway/issues">Issue</a>
    <a class="link" href="https://www.yuque.com/midwayjs/topics">Help</a>
    <a class="link" href="http://demo.midwayjs.org/">Gallery</a>
  
  <a class="bottom-logo"></a>
  
    <a class="link" href="https://github.com/midwayjs/pandora">Pandora</a>
    <a class="link" href="https://github.com/midwayjs/injection">Injection</a>
    <a class="link" href="https://github.com/midwayjs/sandbox-docker">Sandbox</a>
    <a class="link" href="https://ice.work/">ICE</a>