What it is

Midway is an open-source Node.js framework for building serverless services, traditional applications, microservices, and mini-program backends. It is written in TypeScript and released under the MIT license, and it has been developed for roughly eight years, with the most recent push in September 2026. The project lives in the Node.js ecosystem and positions itself as a cloud-integrated framework for front-end and full-stack developers, with integrations for React and Vue.

The concrete problem it addresses is the split between front-end code and back-end deployment targets. Midway lets a developer write back-end logic with decorators and dependency injection, then deploy the same code to AWS, Alibaba Cloud, Tencent Cloud, Azure, or a traditional virtual machine or container. It also supports a "zero API call" development style in which front-end code invokes back-end functions directly in a React Hooks style, removing the need to hand-write and maintain a separate HTTP client layer. For teams that want one framework across serverless and conventional hosting, that removes the need to maintain two codebases.

Key capabilities

• Full-scenario support for web applications, serverless and FaaS functions, microservices, and mini-program backends.
• Decorator-based development with a dependency injection container for enterprise application structure.
• Choice of Koa, Express, or Egg.js as the underlying web framework, with support for their ecosystem plugins.
• Standalone integrations for Socket.io, gRPC, Dubbo.js, and RabbitMQ.
• Cloud-integrated front-end development in a React Hooks style, where back-end functions are called directly without hand-written API calls.
• Component-based extension mechanism for adding capabilities to the framework.
• Full TypeScript support across the framework.

Who uses it and how

• Teams deploying the same application to AWS, Alibaba Cloud, Tencent Cloud, Azure, or a traditional VM or container.
• Full-stack developers building React or Vue front ends that call back-end functions directly instead of through a separate API client.
• Enterprises building microservices or mini-program backends with decorators and dependency injection.
• Developers who need Socket.io, gRPC, Dubbo.js, or RabbitMQ alongside a web framework.
• Projects that adopt the community Cool-Admin permission management framework, which is listed as an example built on Midway.

Getting started

Scaffold a project with npm init midway, then enter the directory and run npm run dev to start development. Documentation and community resources are available at midwayjs.org.

When to use it — and when not to

Midway is a reasonable choice when an application must run both on serverless platforms and on conventional servers, since it avoids committing to a single cloud vendor. A self-hoster should expect to operate the surrounding infrastructure that the chosen deployment target requires, and should note that the README does not describe a hosted offering, so the framework itself is the only layer provided. The project carries 118 open issues and a single primary documentation site, so teams should weigh the maintenance load of a framework that spans several runtimes and cloud providers.

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