Node Http-Status 使用教程

Node Http-Status 使用教程

node-http-status Utility to interact with HTTP status code in Node.js 项目地址: https://gitcode.com/gh_mirrors/no/node-http-status

1. 项目介绍

node-http-status 是一个用于在 Node.js 中处理 HTTP 状态码的实用库。该库提供了所有 IANA HTTP 状态码的名称、信息和类别的访问，并额外添加了一些流行的软件中使用的状态码。此库使用 TypeScript 编写，并支持 CommonJS 和 ESM 模块。

2. 项目快速启动

首先，您需要安装 node-http-status 库。在您的 Node.js 项目中，运行以下命令：

npm install http-status

安装完成后，您可以在代码中这样使用它：

const status = require('http-status');
// 或者，如果您使用 ESM
// import status from 'http-status';

以下是一个快速使用示例：

console.log(status[200]); // 输出: OK
console.log(status[404]); // 输出: Not Found
console.log(status[500]); // 输出: Internal Server Error

3. 应用案例和最佳实践

获取状态码名称

console.log(status[200]); // 输出: OK
console.log(status[200('_NAME')])); // 输出: OK

获取状态码信息

console.log(status[404('_MESSAGE')])); // 输出: The requested resource was not found.

获取状态码类别

console.log(status[500('_CLASS')])); // 输出: 5xx

遍历状态码类别

for (const [key, value] of Object.entries(status.classes)) {
    console.log(`${key}: ${value}`);
}

集成到 Express

const express = require('express');
const app = express();

app.get('/', (req, res) => {
    res.status(status.OK).send('一切正常！');
});

app.get('/not-found', (req, res) => {
    res.status(status.NOT_FOUND).send('页面未找到！');
});

app.listen(3000, () => {
    console.log('应用在 3000 端口上运行');
});

4. 典型生态项目

node-http-status 可以与许多 Node.js 生态项目一起使用，例如：

• Express：用于创建 HTTP 服务器和中间件。
• Redis：用于数据存储和缓存。
• Winston：用于日志记录。

通过结合这些项目，您可以构建强大的网络应用程序，并有效地处理 HTTP 状态码。

node-http-status Utility to interact with HTTP status code in Node.js 项目地址: https://gitcode.com/gh_mirrors/no/node-http-status