Sinatra 技术文档

1. 安装指南

要使用 Sinatra，首先需要安装 Sinatra gem。打开终端并执行以下命令：

gem install sinatra

此外，你可能还需要安装其他 gems，例如 Rackup 和 Puma：

gem install rackup
gem install puma

安装完成后，你可以创建一个名为 myapp.rb 的 Ruby 文件，并在其中编写你的 Sinatra 应用程序代码。

2. 项目的使用说明

以下是一个简单的 Sinatra 应用程序示例。将以下代码保存到 myapp.rb 文件中：

require 'sinatra'

get '/' do
  'Hello world!'
end

然后，运行以下命令启动服务器：

ruby myapp.rb

打开浏览器并访问 http://localhost:4567，你应该会看到 "Hello world!" 的消息。

每次更改代码后，都需要重启服务器才能看到更改。

3. 项目API使用文档

以下是 Sinatra 的一些基本用法和 API：

路由 (Routes)

在 Sinatra 中，一个路由是一个 HTTP 方法，与方法匹配的 URL 模式。每个路由都关联一个代码块。

get '/' do
  'Hello world!'
end

Sinatra 支持以下 HTTP 方法：

• get
• post
• put
• patch
• delete
• options
• link
• unlink

路由参数

路由可以包括命名参数，通过 params 哈希访问：

get '/hello/:name' do
  "Hello #{params['name']}!"
end

还可以通过代码块参数访问命名参数：

get '/hello/:name' do |n|
  "Hello #{n}!"
end

查询参数

路由可以使用查询参数：

get '/posts' do
  title = params['title']
  author = params['author']
end

返回值

路由块的返回值决定了发送给 HTTP 客户端的响应体或至少是传递给下一个 Rack 中间件的响应。通常是字符串，但也可以是其他值：

• 一个包含三个元素的数组：[状态码 (Integer), 头部 (Hash), 响应体 (响应 #each)]
• 一个包含两个元素的数组：[状态码 (Integer), 响应体 (响应 #each)]
• 一个响应 #each 并仅将字符串传递给给定块的对象
• 一个表示状态码的整数

4. 项目安装方式

Sinatra 的安装方式如前所述，通过安装相关 gems 并创建一个 Ruby 脚本来实现。以下是步骤：

1. 安装 Sinatra gem：

   gem install sinatra
   

2. 创建一个 Ruby 脚本，例如 myapp.rb，并编写 Sinatra 应用程序代码。

3. 运行脚本以启动服务器：

   ruby myapp.rb
   

4. 在浏览器中访问 http://localhost:4567 查看应用程序。