Skip to content

Latest commit

 

History

History
128 lines (93 loc) · 2.49 KB

README.md

File metadata and controls

128 lines (93 loc) · 2.49 KB

nihongoparserd

A service to convert japanese languages into romaji, kana etc.

for the moment it's based on libmecab but it may be replaced by homebrew parser in the future

Building and running

With Docker

Since getting this code to compile under macOS (the use of strdupa from the GNU C++ extensions may be hard or impossible under clang++), this repo contains a Dockerfile:

$ docker build -t nihongoparserd .
$ docker run -t -i -p 8842:8842 nihongoparserd

You can then hit the service at localhost:8842 like so.

To kill the service, you can:

$ docker ps #<-- to find the container ID
$ docker kill <that_container_id>

Building manually (without Docker)

Requirements

  • libexpat
  • libevent
  • libmecab2
  • cmake
  • a C++11 compatible compiler with GNU's stdlib
  • a dictionary (e.g. mecab-ipadic-utf8)

Building

To build the project:

$ cmake .
$ make

To run the server:

    ./nihonggoparserd -p PORT [-h HOSTNAME]

That will launch an HTTP server listening on port PORT, bound to HOSTNAME.

Usage

It provides the following API calls, that will return an XML answer. Note that contents are wrapped into <![CDATA[...]]>, which is removed from the following examples for readability.

Parse

URL: /parse?str=*

Example of response for /parse?str=学校は家から遠いの？

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <parse>
        <token>学校</token>
        <token>は</token>
        <token>家</token>
        <token>から</token>
        <token>遠い</token>
        <token>の</token>
        <token>？</token>
    </parse>
</root>

Furigana

URL: /furigana?str=*

Example of response for /furigana?str=学校は家から遠いの？

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <parse>
       <token>
           <reading furigana="がっこう">学校</reading>
       </token>
       <token>は</token>
       <token>
           <reading furigana="いえ">家</reading>
       </token>
       <token>から</token>
       <token>
           <reading furigana="とお">遠></reading>
           い
       </token>
       <token>の</token>
       <token>？</token>
    </parse>
</root>

Kana

URL: /kana?str=*

Example of rensponse for /kana?str=学校は家から遠いの？

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <kana>がっこうはいえからとおいの？</kana>
</root>