Short 项目技术文档

1. 安装指南

环境要求

• Node.js 版本 >= 12.x
• MongoDB 数据库

安装步骤

1. 打开终端或命令行工具。
2. 使用 npm 安装 short 包：

   $ npm install short
   

2. 项目的使用说明

基本使用

short 是一个基于 Node.js 和 MongoDB 的 URL 缩短器。它使用 Mongoose.js 作为数据库驱动，并且完全基于 Promise，避免了回调地狱。

示例代码

以下是一个简单的示例，展示如何生成一个短 URL 并检索它：

var shortURLPromise
  , short = require('short');

// 连接到 MongoDB
short.connect('mongodb://localhost/short');

short.connection.on('error', function(error) {
  throw new Error(error);
});

// 生成一个短 URL
var shortURLPromise = short.generate({
  URL : 'http://nodejs.org/'
});

shortURLPromise.then(function(mongodbDoc) {
  console.log('>> 创建的短 URL:');
  console.log(mongodbDoc);
  console.log('>> 检索短 URL: %s', mongodbDoc.hash);
  short.retrieve(mongodbDoc.hash).then(function(result) {
    console.log('>> 检索结果:');
    console.log(result);
    process.exit(0);
  }, function(error) {
    if (error) {
      throw new Error(error);
    }
  });
}, function(error) {
  if (error) {
    throw new Error(error);
  }
});

3. 项目API使用文档

生成短 URL

short.generate({ URL: 'http://example.com' });

• 参数:
  • URL: 需要缩短的原始 URL。
• 返回值: 返回一个 Promise，解析后得到包含短 URL 信息的 MongoDB 文档。

检索短 URL

short.retrieve(hash);

• 参数:
  • hash: 短 URL 的哈希值。
• 返回值: 返回一个 Promise，解析后得到原始 URL 信息。

列出所有短 URL

short.list();

• 返回值: 返回一个 Promise，解析后得到所有短 URL 的列表。

更新短 URL

short.update(hash, updateData);

• 参数:
  • hash: 短 URL 的哈希值。
  • updateData: 包含新 URL 或数据的对象。
• 返回值: 返回一个 Promise，解析后得到更新后的短 URL 对象。

4. 项目安装方式

通过 npm 安装

$ npm install short

手动安装

1. 克隆项目仓库：

   $ git clone https://github.com/edwardhotchkiss/short.git
   

2. 进入项目目录：

   $ cd short
   

3. 安装依赖：

   $ npm install
   

通过以上步骤，您可以成功安装并使用 short 项目。