Sawyer 使用与技术文档

1. 安装指南

Sawyer 是一个基于 Faraday 库构建的 Ruby 实验性超媒体代理。在您的应用程序的 Gemfile 中添加以下内容以安装 Sawyer：

gem 'sawyer'

然后执行以下命令：

bundle

或者，您也可以自行安装：

gem install sawyer

2. 项目使用说明

首先，需要引入 Sawyer 库：

require "sawyer"

创建一个 Sawyer 代理实例：

agent = Sawyer::Agent.new("https://api.github.com",
  links_parser: Sawyer::LinkParsers::Simple.new)

获取 API 的根目录：

root = agent.root.data

直接访问一个资源：

contributors = agent.call(:get, "repos/lostisland/sawyer/contributors").data

加载一个超媒体关系：

top_contributor = contributors.first
followers = top_contributor.rels[:followers].get.data

更多详细信息，请查看相关文档。

3. 项目API使用文档

Sawyer 的 API 使用主要依赖于创建的代理实例。以下是部分 API 的使用示例：

• agent.root: 获取 API 的根目录。
• agent.call(method, url): 发起 HTTP 请求，其中 method 是请求方法（如 :get、:post 等），url 是请求的 URL。
• rels[relation]: 获取一个超媒体关系，其中 relation 是关系的名称。

4. 项目安装方式

项目的安装方式已在安装指南中说明，以下为简要总结：

• 通过 Gemfile 添加依赖后执行 bundle 命令安装。
• 使用 gem install sawyer 命令自行安装。