{"id":17159497,"url":"https://github.com/tomholford/jisho-api","last_synced_at":"2025-04-13T13:31:54.910Z","repository":{"id":48157525,"uuid":"246270330","full_name":"tomholford/jisho-api","owner":"tomholford","description":"Ruby client gem for the unofficial Jisho API","archived":false,"fork":false,"pushed_at":"2023-03-17T02:34:48.000Z","size":23,"stargazers_count":10,"open_issues_count":3,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-09T04:34:22.368Z","etag":null,"topics":["api","japanese","jisho","ruby","ruby-gem"],"latest_commit_sha":null,"homepage":"https://rubygems.org/gems/jisho_api","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tomholford.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-10T10:23:01.000Z","updated_at":"2023-07-27T02:42:29.000Z","dependencies_parsed_at":"2023-02-12T05:55:13.965Z","dependency_job_id":null,"html_url":"https://github.com/tomholford/jisho-api","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomholford%2Fjisho-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomholford%2Fjisho-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomholford%2Fjisho-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomholford%2Fjisho-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tomholford","download_url":"https://codeload.github.com/tomholford/jisho-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248721147,"owners_count":21151052,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","japanese","jisho","ruby","ruby-gem"],"created_at":"2024-10-14T22:14:25.602Z","updated_at":"2025-04-13T13:31:49.896Z","avatar_url":"https://github.com/tomholford.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JishoAPI\n\nAn unofficial Ruby gem client for [Jisho](https://jisho.org), a Japanese dictionary. \n\nFor details about the API, check out [this thread](https://jisho.org/forum/54fefc1f6e73340b1f160000-is-there-any-kind-of-search-api) by the [developer](https://github.com/Kimtaro).\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'jisho_api'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install jisho_api\n\n## Usage\n\n### Querying\n\nA search `query` is required, and can be set in a few ways:\n\n```ruby\nrequire 'jisho_api'\n\n# Class method\nJishoAPI::JishoAPI.search('hamburger')\n\u003e\u003e [{ ... }]\n\n# Initializer\napi = JishoAPI::JishoAPI.new(query: 'ピザ')\n\n# Accessor\napi.query = '#jlpt-n5'\n\n# Instance method\napi.search # will use the internally stored query\n\u003e\u003e [{ ... }]\n\napi.search(query: 'something else') # will override (but not set) the internally stored query\n\u003e\u003e [{ ... }]\n\n```\n\n### Pagination\n\nBy default, the gem will fetch the first page of results. There are also a few ways to override this behavior:\n\n```ruby\n\n# Initializer\napi = JishoAPI::JishoAPI.new(query: 'ピザ', page: 2)\n\n# Accessor\napi.page = 3\n\n# Instance methods\n# Fetching a page for a given query\napi.search(query: 'something else', page: 2)\n\u003e\u003e [{ ... }]\n\n# This increments the internal page counter and executes a request\napi.next_page!\n\u003e\u003e [{ ... }]\n\nputs api.page\n\u003e\u003e 4\n```\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/tomholford/jisho-api.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomholford%2Fjisho-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftomholford%2Fjisho-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomholford%2Fjisho-api/lists"}