https://github.com/nbw/jisho_elixir

A Japanese dictionary API; a wrapper around Jisho's API (http://jisho.org)
https://github.com/nbw/jisho_elixir

Last synced: about 1 month ago
JSON representation

A Japanese dictionary API; a wrapper around Jisho's API (http://jisho.org)

• Host: GitHub
• URL: https://github.com/nbw/jisho_elixir
• Owner: nbw
• License: mit
• Created: 2017-08-31T06:09:16.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-03-08T14:05:39.000Z (almost 5 years ago)
• Last Synced: 2024-10-25T02:03:28.736Z (about 2 months ago)
• Language: Elixir
• Homepage: https://hexdocs.pm/jisho_elixir
• Size: 10.7 KB
• Stars: 34
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - An API wrapper for Jisho.org, an online Japanese dictionary. Allows users to search by word, symbol, and or tags (refer to docs). (Miscellaneous)
• fucking-awesome-elixir - Jisho-Elixir - An API wrapper for Jisho.org, an online Japanese dictionary. Allows users to search by word, symbol, and or tags (refer to docs). (Miscellaneous)
• awesome-elixir - Jisho-Elixir - An API wrapper for Jisho.org, an online Japanese dictionary. Allows users to search by word, symbol, and or tags (refer to docs). (Miscellaneous)

README

        
[![](http://assets.jisho.org/assets/jisho-logo-v4@2x-7330091c079b9dd59601401b052b52e103978221c8fb6f5e22406d871fcc746a.png)](http://jisho.org/)

# JishoElixir [![Hex pm](http://img.shields.io/hexpm/v/jisho_elixir.svg?style=flat)](https://hex.pm/packages/jisho_elixir)

A wrapper around Jisho.org's API (http://jisho.org).

### What is [Jisho.org](http://jisho.org/)?

It's an online Japanese to English dictionary that you can read about [here](http://jisho.org/about).

### JishoElixir currently Supports

1. Searching by word

2. Searching by tags [http://jisho.org/docs](http://jisho.org/docs)

3. Searching for verbs 

4. And much more if you combine them.  

## Installation

First, add JishoElixir to your mix.exs dependencies:

```elixir

def deps do

  [

    {:jisho_elixir, "~> 0.1.0"}

  ]

end

```

and run $ mix deps.get

## Usage

Your best bet is to visit the hex docs, but:

```elixir

	JishoElixir.search("峠", ["n", "exp"], 1)

```

```elixir

	JishoElixir.tag("jlpt-n1")

```

```elixir

	JishoElixir.verb("prance")

```

## FAQ

### What about formatting the response?

The library returns a map that's been parsed directly from json. I leave it up to you to write a wrapper around it. 

### Do I need an API key?

Nope.

### Where can I find documentation for the Jisho API

At the moment, just [here](http://jisho.org/forum/54fefc1f6e73340b1f160000-is-there-any-kind-of-search-api).

### What about kanji?

It's been hinted by the Jisho team that it's on the way, but for now you can search kanji the same way you search a word. The downside is kanji _tags_ (found [here](http://jisho.org/docs)) won't work. 

## Thanks

Thank you to the [Jisho.org](http://jisho.org/) team, especially [Kimtaro](https://github.com/Kimtaro).