README

Spellcheck API

The API server needs node version 0.11.0 or higher and to be ran with the --harmony flag.

Install

git clone git@github.com:montanaflynn/Spellcheck-API.git
npm install

Usage

node --harmony ./server.js [port]

Default port is 8080.

Example

node --harmony server 1337 &
curl "localhost:1337?text=wrng"

{
  "original": "wrng",
  "suggestion": "wrong",
  "corrections": {
    "wrng": [
      "wrong",
      "wing",
      "wring",
      "wrung"
    ]
  }
}

Responses

If there is no text querystring parameter return error message:

{"error":"Missing 'text' query parameter"}

If there are no mistakes return false for suggestion.

{
  "original": "the words are fine.",
  "suggestion": false
}

If there are mistakes but no suggestions return null for suggestion and corrections.

{
  "original": "dfdgdfg is gfdgdfsg.",
  "suggestion": null,
  "corrections": {
    "dfdgdfg": null,
    "gfdgdfsg": null
  }
}

If there are mistakes and suggestions return an array for each correction and replace the word in the suggestion string.

{
  "original": "thefdeee123 is theedffdfde is baddd.",
  "suggestion": "thefdeee123 is theedffdfde is bad.",
  "corrections": {
    "thefdeee123": null,
    "theedffdfde": null,
    "baddd": [
      "bad",
      "addd",
      "bddd",
      "badd"
    ]
  }
}

FAQ

Didn't this use to be a PHP project?

Yes indeed, however the PHP version is no longer supported. The source code is still available.

Contributing

Forks and pull requests are most welcomed.

License

The MIT License (MIT)

spellcheck-api

Usage no npm install needed!