Word Opposites API - Ruby Gem

Word Opposites is a simple tool for getting the opposites of a word. It returns a list of opposites for the given word.

Installation

Add this line to your application's Gemfile:

gem 'apiverve_wordopposite'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install apiverve_wordopposite

Getting Started

Get your API key at APIVerve

Basic Usage

require 'apiverve_wordopposite'

# Initialize the client
client = APIVerve::Wordopposite::Client.new(api_key: "YOUR_API_KEY")

# Make a request
response = client.execute({ word: "hot" })

# Print the response
puts response

Error Handling

begin
  response = client.execute({ word: "hot" })
  puts response["data"]
rescue APIVerve::Wordopposite::ValidationError => e
  puts "Validation error: #{e.errors.join(', ')}"
rescue APIVerve::Wordopposite::APIError => e
  puts "API error: #{e.message}"
  puts "Status code: #{e.status_code}"
end

Debug Mode

# Enable debug logging
client = APIVerve::Wordopposite::Client.new(
  api_key: "YOUR_API_KEY",
  debug: true
)

Example Response

{
  "status": "ok",
  "error": null,
  "data": {
    "word": "hot",
    "opposites": [
      "cold",
      "cool",
      "chilly",
      "frozen",
      "frigid"
    ]
  }
}

Documentation

For more information, visit the API Documentation.

Support

License

This gem is available under the MIT License.