express-api-bootstrap

超快速创建API服务

快速开始 →

简明

API不多，复杂度不高。任何你看到的API，都能得到你理解的内容。完善的类型系统还可以依托于vscode给您提供良好的编程体验

约定

所有配置都是可选的。只想关注业务逻辑，快速开发原型服务，不再是梦

完整

开发模式下可自动按需编译; 发布模式编译; 轻松调试; 轻松编写测试用例;

express-api-bootstrap 受启发于springboot，基于express实现。使开发 API service 更轻松。你要做的，就是关注业务，然后运行。剩下的，我们为您搞定

# 快速开始

1 分 15 秒创建你的第一个 API 服务

# 环境搭建

# 创建新项目目录
mkdir test-boot-app
cd test-boot-app

# 无交互模式生成一个基本的package.json
npm init -y

# 用 yarn 添加依赖
yarn add express-api-bootstrap

# 用 npm 添加依赖
npm i express-api-bootstrap --save

# 初始化 express-api-bootstrap 所需环境
npx boot init

打开 package.json，添加/修改如下片段：

{
  "scripts": {
    "start": "boot dev",
    "build": "boot build",
    "serve": "boot serve",
    "test": "boot test"
  }
}

创建文件： src/controllers/helloController.ts，编写如下内容：

import { HttpRequest, RestController, GetMapping } from 'express-api-bootstrap'

@RestController()
class HelloControler {
  @GetMapping('/hello')
  sayHello(req: HttpRequest) {
    return {
      say: `Hi, ${req.query.name}`
    }
  }
}

export default HelloControler

执行 yarn start ，然后你的第一个 API http://localhost:8080/apis/hello 就完成了

# 如何贡献？

看贡献代码

# LICENSE

MIT License