基于 Node.js 构建完整服务端应用(创建 Node.js Web API 项目篇)

主题内容：在 macOS Big Sur /  Windows 10 上创建 Node.js Web API 项目 / 创建项目目录结构（项目骨架）
目标框架：Node.js v14.15.4 (包含 npm 6.14.10)
开发工具：Visual Studio Code （VS Code）
开发平台：macOS Big Sur 11.1  /  Windows 10
开发人员：成长的小猪 Jason Song
背景描述：上一篇 基于Node.js构建完整服务端应用(开发环境安装篇) 讲述了Node.js服务端应用 开发环境和开发工具安装，下同我们接下来是创建 Node.js Web API  项目（解决方案），考虑到大家使用的系统不一样，下面创建项目示例分 Mac OS 和 Windows 进行展示，不多说了，开始干......

• 在 Windows 10 上创建 Node.js Web API 项目

打开“cmd命令提示符” cd 命令进入到自己存放项目的目录里（避免目录名不要有中文名称），命名自己的项目名称，我这里展示的项目名称定义为 “ jasonsoft-koa-server”，创建项目目录，可以按下图操作

C:\Users\jason>cd Projects

C:\Users\jason\Projects>mkdir jasonsoft-koa-server

C:\Users\jason\Projects>cd jasonsoft-koa-server

然后cd 进入到刚刚创建的项目 “jasonsoft-koa-server”中，我们将通过下面的命令初始化项目，执行 “ npm init -y ”

C:\Users\jason\Projects\jasonsoft-koa-server>npm init -y

这样Node.js项目就初始化好了，接下来可以通过快捷命令打开刚刚创建的项目，在 “jasonsoft-koa-server” 项目根目录下执行 “ code . ”即可通过 VS Code 打开刚刚创建好的项目

C:\Users\jason\Projects\jasonsoft-koa-server>code .

或者打开 VS Code > Open Folder > 选择到刚刚创建的项目目录，这里是 “jasonsoft-koa-server”，

操作到这里，项目初始化了，

• 在 Mac OS 上创建 Node.js Web API 项目

打开终端“terminal”，cd 命令进入到自己存放项目的目录里（避免目录名不要有中文名称），mkdir 命令创建项目目录“jasonsoft-koa-server”，进入项目目录，我们将通过下面的命令初始化项目，执行 “ npm init -y ”

➜  ~ cd Projects/Node 

➜  mkdir jasonsoft-koa-server 

➜  cd jasonsoft-koa-server 

➜  jasonsoft-koa-server git:(main) ✗ npm init -y
Wrote to /Users/jason/Projects/Node/jasonsoft-koa-server/package.json:

{
  "name": "jasonsoft-koa-server",
  "version": "1.0.0",
  "description": "Koa server example",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/JasonSoft-Net/jasonsoft-koa-server.git"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "bugs": {
    "url": "https://github.com/JasonSoft-Net/jasonsoft-koa-server/issues"
  },
  "homepage": "https://github.com/JasonSoft-Net/jasonsoft-koa-server#readme"
}

上面出现一些与你们不一样的原因是，我个目录加入到github，后面我做的所有操作都会提交至GitHub上，后面大家可以有上GitHub上查看示例源码 ，到这里 Mac OS 上的创建解决方案已成功，接下来我们通过 VS Code 打开项目文件夹，如下图 VS Code > Open Folder > 选择到刚刚创建的项目目录，这里是 “jasonsoft-koa-server”

在MacOS上，在项目根目录下执行 “ code . ”，默认是不能执行的，需要安装该命令才能使用，请按下面的方法操作，即可使用 执行 “ code . ”即可通过 VS Code 打开刚刚创建好的项目

 

• 创建项目目录结构（项目骨架）

经过上面的操作（如下图），我们已经初始化好项目，接下来把项目的目录结构创建好，不一定完整，后面我们可以继续添加，请按下面的提示创建相关目录

jasonsoft-koa-server
├── package.json
├── bin
|   ├── start.js (启动入口文件)
├── app.js (初始化相关服务)
├── app
│   ├── config
|   |   ├── index.js (初始化配置信息)
|   |   ├── config.dev.js (开发环境配置)
|   │   └── config.prd.js (生产环境配置)
│   ├── controllers (控制器)
│   ├── services (服务层-业务逻辑层)
│   ├── models (数据库实体)
│   ├── utils (公共方法)
│   ├── middlewares (中间件)
│   └── schedules (定时任务)
├── public (静态资源文件)
└── test (单元测试)

 

项目源码地址：https://github.com/JasonSoft-Net/jasonsoft-koa-server

上一篇 基于Node.js构建完整服务端应用(开发环境安装篇)

下一篇 基于 Node.js + Koa 构建完整的 Web API 项目

 

 如果此文对你有一点点帮助，请给一个赞哦；如果你对此文感兴趣，请关注我，后面将继续更新相关内容，查看我本人更多原创文章，请点击这里=>。