HTTP Router 技术文档

1. 安装指南

环境要求

• Ruby 2.0 或更高版本
• Rack 1.0 或更高版本

安装步骤

1. 打开终端或命令行工具。
2. 使用 gem 命令安装 http_router：

   gem install http_router
   

3. 安装完成后，您可以在项目中使用 require 'http_router' 来引入该库。

2. 项目的使用说明

概述

HTTP Router 是一个用于 Web 框架或独立使用 Rack 的 HTTP 路由器。它通过一组路由来尝试找到最佳匹配。您可以在 examples 目录中查看如何在 Rack 上下文中使用它的示例。

主要功能

• 有序路由解析
• 支持变量和通配符，包括命名和未命名的
• 正则表达式支持
• 请求条件支持
• 部分匹配
• 支持中间变量（例如 /my-:variable-brings.all.the.boys/yard）和未命名变量 /one/:/two
• 代码库非常小且快速（约 1000 行代码）

使用示例

以下是一个简单的使用示例：

require 'http_router'

r = HttpRouter.new
r.add('/test/:variable(.:format)').name(:my_test_path).to {|env| [200, {}, "Hey dude #{env['router.params'][:variable]}"]}
r.add('/test').redirect("http://www.google.com/")
r.add('/static').static('/my_file_system')

run r

3. 项目API使用文档

HttpRouter.new

创建一个新的 HTTP 路由器实例。

选项：

• :default_app - 默认的非匹配处理程序，默认为 404 生成器。
• :ignore_trailing_slash - 匹配时忽略末尾的斜杠，默认为 true。
• :middleware - 执行匹配时不委托给匹配的路由，默认为 false。

#add(name, options)

映射一个路由。路径中的变量格式为 :variable 或 *glob。其他部分按字面处理。可选部分用括号包围，部分匹配路径以 * 结尾，可选的末尾斜杠匹配用 /? 表示。

示例：

r = HttpRouter.new
r.add('/test/:variable(.:format)').name(:my_test_path).to {|env| [200, {}, "Hey dude #{env['router.params'][:variable]}"]}

#url(name or route, *args)

生成一个路由。参数可以是哈希、列表或两者的混合。

#call(env)

识别并分派请求。env 应该是一个表示 Rack 环境的哈希。

#recognize(env)

仅执行识别操作。env 应该是一个表示 Rack 环境的哈希。

4. 项目安装方式

通过 RubyGems 安装

使用以下命令通过 RubyGems 安装 http_router：

gem install http_router

在项目中使用

在您的 Ruby 项目中，使用 require 'http_router' 引入该库，然后按照上述使用说明进行配置和使用。

---

通过以上文档，您应该能够顺利安装和使用 HTTP Router 项目。如有任何问题，请参考项目提供的示例和文档进行进一步的调试和学习。