Hoxy 项目技术文档

1. 安装指南

1.1 安装 Node.js

在安装 Hoxy 之前，请确保您的系统上已经安装了 Node.js。您可以通过以下命令检查是否已安装 Node.js：

node -v

如果没有安装，请访问 Node.js 官方网站 下载并安装适合您操作系统的版本。

1.2 安装 Hoxy

安装 Hoxy 非常简单，只需在终端中运行以下命令：

npm install hoxy

这将自动从 npm 仓库下载并安装 Hoxy 及其依赖项。

2. 项目的使用说明

2.1 创建代理服务器

Hoxy 是一个用于 HTTP 流量嗅探和操作的工具。您可以通过以下代码创建一个简单的代理服务器：

var hoxy = require('hoxy');
var proxy = hoxy.createServer().listen(8080);

2.2 拦截和修改响应

您可以通过拦截请求和响应来修改 HTTP 流量。以下是一个示例，展示了如何拦截 HTML 页面的响应并修改标题：

proxy.intercept({
  phase: 'response',
  mimeType: 'text/html',
  as: '$'
}, function(req, resp) {
  resp.$('title').text('Unicorns!');
});

在这个示例中，所有页面的标题将被修改为 "Unicorns!"。

3. 项目 API 使用文档

3.1 createServer()

创建一个新的代理服务器实例。

var proxy = hoxy.createServer();

3.2 listen(port)

启动代理服务器并监听指定端口。

proxy.listen(8080);

3.3 intercept(options, callback)

拦截 HTTP 请求或响应，并执行自定义操作。

proxy.intercept({
  phase: 'response',
  mimeType: 'text/html',
  as: '$'
}, function(req, resp) {
  resp.$('title').text('Unicorns!');
});

3.4 cycle 对象

cycle 对象包含了请求和响应的完整生命周期信息。您可以通过 this 或作为回调的第三个参数访问它。

proxy.intercept({
  phase: 'response',
  mimeType: 'text/html',
  as: '$'
}, function(req, resp, cycle) {
  console.log(cycle.request.url);
});

4. 项目安装方式

4.1 通过 npm 安装

Hoxy 可以通过 npm 进行安装，这是最常用的安装方式：

npm install hoxy

4.2 全局安装（可选）

如果您希望在全局范围内使用 Hoxy，可以将其安装为全局模块：

npm install -g hoxy

4.3 从 GitHub 安装

如果您需要使用最新的开发版本，可以直接从 GitHub 仓库安装：

npm install greim/hoxy

通过以上步骤，您可以顺利安装并开始使用 Hoxy 项目。希望这篇文档能帮助您更好地理解和使用 Hoxy。