DNSimple Ruby客户端技术文档

1. 安装指南

系统要求

• Ruby版本：MRI > 3.1+

安装方式

您可以通过以下两种方式安装DNSimple Ruby客户端：

• 手动安装：

  gem install dnsimple
  

• 使用Bundler：

  在Gemfile中定义依赖项：

  gem 'dnsimple', '~> 8.0'
  

  然后，执行bundle install命令安装。

2. 使用说明

在开始使用之前，请确保已安装DNSimple Ruby客户端。以下是一些基本的使用示例：

引入客户端

在使用示例之前，请确保引入了gem：

require 'dnsimple'

设置自定义User-Agent头

您可以自定义发送到DNSimple API的User-Agent头：

client = Dnsimple::Client.new(user_agent: "my-app/1.0")

认证

创建客户端实例时，需要提供一个访问令牌：

client = Dnsimple::Client.new(access_token: "a1b2c3")

获取用户信息

response = client.identity.whoami   # 执行调用
response.data                       # 从响应中提取相关数据
client.identity.whoami.data         # 执行调用并一次性获取数据

列出域名

account_id = 1010  # 替换为您的账户ID

puts client.domains.list_domains(account_id).data                      # => 账户1010中的域名，第一页
puts client.domains.list_domains(account_id, query: { page: 3 }).data  # => 账户1010中的域名，第三页
puts client.domains.all_domains(account_id).data                       # => 账户1010中的所有域名（谨慎使用）

创建域名

response = client.domains.create_domain(account_id, name: "example.com")
puts response.data

获取域名信息

response = client.domains.domain(account_id, "example.com")
puts response.data

3. 项目API使用文档

DNSimple Ruby客户端提供了与DNSimple API v2交互的接口。以下是一些常用的API调用：

• identity.whoami: 获取当前认证用户的信息。
• domains.list_domains: 列出指定账户下的域名。
• domains.create_domain: 创建一个新的域名。
• domains.domain: 获取指定域名的详细信息。

更多API调用和详细信息，请参考DNSimple API文档。

4. 项目安装方式

请参考“安装指南”部分。您可以选择手动安装或使用Bundler进行安装。