**ApiStruct**：优雅的API客户端和实体序列化框架

ApiStruct 是一个强大且灵活的Ruby库，它提供了两个主要接口——ApiStruct::Client 和 ApiStruct::Entity。设计用于统一不同API请求的接口，并以ORM风格处理API响应数据。

安装与使用

在你的Gemfile中添加以下代码：

gem 'api_struct'

然后运行：

$ bundle

或者直接安装：

$ gem install api_struct

初始化API路由配置：

ApiStruct::Settings.configure do |config|
  config.endpoints = {
    first_api: {
      root: 'http://localhost:3000/api/v1',
      headers: {
        'content-type': 'application/json',
        'Authorization': 'Bearer TOKEN'
      }
    },
    second_api: {
      root: 'http://localhost:3001/api/v1',
      params: { token: 'Default token' }
    }
  }
end

客户端（Client）

通过创建子类并定义方法，可以轻松封装API接口：

class PostsClient < ApiStruct::Client
  first_api :posts

  # 省略...
end

例如，调用show方法将访问/posts/1：

PostsClient.new.show(1) 

返回的结果是一个封装了数据的Result对象：

# => Success({:id=>1, :title=>"Post"})

实体（Entity）

ApiStruct::Entity使得序列化API响应变得简单：

class User < ApiStruct::Entity
  client_service UsersClient

  # 省略...
end

你可以直接调用如User.show(1)的方法获取数据，甚至关联其他实体：

user = User.show(1)
# => {"id"=>1, "name"=>"John"}

user.name
# => "John"

应用场景

ApiStruct适用于任何需要从RESTful API获取和操作数据的场合，特别是在多API集成或需要灵活处理API请求头的情况下。例如，构建单页应用（SPA）、后端服务间通信（微服务架构）以及API代理服务等。

项目特点

• 统一接口：无论API如何变化，都可通过一致的接口进行交互。
• ORM式体验：通过定义实体，可以方便地读取和操作API响应数据，如同数据库记录一般。
• 动态头部：支持在请求时动态设置或计算HTTP头部，例如令牌管理。
• 易于扩展：简单易懂的API设计，方便自定义和扩展。

欢迎加入到 ApiStruct 的行列，让我们一起简化API开发，提升工作效率！如果你有任何问题或者贡献，请访问我们的GitHub仓库：https://github.com/rubygarage/api_struct。

由RubyGarage倾情打造，我们是一家专注于软件开发和咨询服务的领先公司，拥有丰富的Ruby on Rails及其他技术经验。了解更多信息，请访问https://rubygarage.org/!