Guillotine 项目技术文档

1. 安装指南

Guillotine 是一个简单的 URL缩短器，支持多种数据存储适配器。以下是安装和配置 Guillotine 的基本步骤：

• 首先，确保您的系统中已经安装了 Ruby 环境。
• Guillotine 依赖于一些 Ruby Gem 包，您可以使用 gem install guillotine 命令来安装它们。

2. 项目的使用说明

Guillotine 的使用非常简单。以下是使用内置内存适配器的基本步骤：

在 app.rb 文件中，您需要创建一个继承自 Guillotine::App 的类，并设置一个适配器：

require 'guillotine'

module MyApp
  class App < Guillotine::App
    adapter = Guillotine::Adapters::MemoryAdapter.new
    set :service => Guillotine::Service.new(adapter)

    get '/' do
      redirect 'https://homepage.com'
    end
  end
end

在 config.ru 文件中，您需要引入 app.rb 并运行您的应用：

require "rubygems"
require File.expand_path("../app.rb", __FILE__)
run MyApp::App

启动您的 Ruby 服务器后，您可以通过 POST 请求来添加 URL：

curl http://localhost:4567 -i \
  -F "url=http://techno-weenie.net"

您还可以指定自定义的短代码：

curl http://localhost:4567 -i \
  -F "url=http://techno-weenie.net" \
  -F "code=abc"

3. 项目API使用文档

Guillotine 的 API 非常简单。它主要接受 POST 请求来添加新的 URL 并生成短代码。以下是基本的 API 使用方法：

• 添加 URL
  通过发送一个 POST 请求到 / 路径，并带上 url 和可选的 code 表单数据来添加一个新的 URL。

• 响应格式
  服务器将返回一个 JSON 对象，包含原始 URL 和生成的短代码。

4. 项目安装方式

如上所述，安装 Guillotine 需要以下步骤：

• 确保您的系统中安装了 Ruby。
• 使用 gem install guillotine 命令安装 Guillotine Gem 包。
• 根据您的需求，选择合适的数据存储适配器（内存、数据库、Redis、Riak、Cassandra）。
• 编写您的应用程序，配置 Guillotine 服务，并启动您的 Ruby 服务器。

请根据您的具体需求调整和扩展这些基本步骤。