利用Node.js的Koa框架开发Restful API服务

举报
zekelove 发表于 2021/07/31 14:38:29 2021/07/31
【摘要】 利用Node.js的Koa框架开发Restful API服务,学习Node,npm,Koa的安装和配置,简单使用Koa开发一个API示例。

Node.js 是一个基于Chrome JavaScript 运行时建立的一个平台,是一个事件驱动I/O服务端JavaScript环境,基于Google的V8引擎,V8引擎执行Javascript的速度非常快,性能非常好。

Node.js安装配置

打开官网:https://nodejs.org/zh-cn/   点击导航“下载“,进入下载页面,选择对应的系统版本进行下载安装。

其它版本:https://nodejs.org/zh-cn/download/releases/

安装完成后,打开“命令提示符”窗口,输入:node -v    出现版本信息说明安装成功。

NPM介绍

NPM是随同NodeJS一起安装的包管理工具,能解决NodeJS代码部署上的很多问题,如下:

  • 允许用户从NPM服务器下载别人编写的第三方包到本地使用。
  • 允许用户从NPM服务器下载并安装别人编写的命令行程序到本地使用。
  • 允许用户将自己编写的包或命令行程序上传到NPM服务器供别人使用。

打开“命令提示符”窗口,输入:npm -v    出现版本信息说明安装成功。

查看 npm 配置信息:

npm config list

Node 和 NPM 配置

使用 npm 安装模块分为本地安装和全局安装,如果没有设置全局目录 node_global,全局安装的文件将会安装保存到 C:\Users\xxx\AppData\Roaming\npm 文件夹里面。(xxx是自己的计算机名字)。

安装好 node 后,我们要设置一下 node_global 和 node_cache (缓存文件夹)。

1.创建 node_global 和 node_cache 文件夹

在 node 安装目录或者其它盘符自定义的文件夹(D:\nodejs)里面创建 node_global 和 node_cache 文件夹。

2.配置环境变量

用户变量设置:将用户变量中 PATH 的值改成新创建的 node_global 路径: C:\Program Files\nodejs\node_global,没有PATH,可以直接添加。

系统变量设置:添加变量 NODE_PATH  值为:C:\Program Files\nodejs\node_modules,node 的安装路径。

3.打开命令提示符窗口,执行

npm config set prefix "C:\Program Files\nodejs\node_global"   

npm config set cache "C:\Program Files\nodejs\node_cache"

4.配置 npm 使用淘宝镜像

npm install -g cnpm --registry=https://registry.npm.taobao.org

npm 安装模块

// 全局安装 -g
npm install koa -g

Restful API 规范

REST:Representational State Transfer (表象层状态转变),是web服务的一种架构风格,一种设计风格,是一种思想。

三个单词意义:

1.每一个URL代表一种资源;

2.客户端和服务器之间,传递这种资源的某种表现层;

3.客户端通过HTTP动词(GET、POST、PUT、DELETE、OPTIONS...),对服务器端资源进行操作,实现“表现层状态转化”。

六大原则:

1.C-S架构

2.无状态

3.统一的接口

4.一致的数据格式

5.系统分层

6.可缓存

Koa 的使用

Koa 是一个新的 web 框架,由 Express 幕后的原班人马打造, 致力于成为 web 应用和 API 开发领域中的一个更小、更富有表现力、更健壮的基石。 通过利用 async 函数,Koa 帮你丢弃回调函数,并有力地增强错误处理。 Koa 并没有捆绑任何中间件, 而是提供了一套优雅的方法,帮助您快速而愉快地编写服务端应用程序。

常用中间件

路由:koa-router

body解析器:koa-bodyparser

视图模板渲染:koa-views

用户状态:koa-session

输出请求日志:koa-logger

JWT认证:koa-jwt

静态资源:koa-static

安装脚手架

npm install koa-generator -g

创建项目

koa myapp   // 创建 koa 的项目
cd myapp 
npm install 或 cnpm install   // 安装依赖
npm start   // 启动项目

手动创建项目

创建文件夹 koa-demo,创建 app.js 文件

cd koa-demo
npm init   // 初始化 package
// 安装依赖包
cnpm install koa --save
cnpm install koa-router
cnpm install koa-logger

 打开 app.js 文件编写

const Koa = require('koa');
const path = require('path');
const logger = require('koa-logger');
const Router = require('koa-router');

const app = new Koa();
const router = new Router();

app.use(logger());

// 请求路由
router.get('/demo', async (ctx) => {
    ctx.body = '欢迎学习Koa!';
});

// 装载所有路由
app.use(router.routes()).use(router.allowedMethods());

// 启动监听端口
app.listen(3000, () => {
    console.log('koa starts at port 3000!');
});

这是一个简单的入门过程,后续在写Restful API的设计实现和其它中间件的使用。

【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息, 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。