Giter Club home page Giter Club logo

wordplay's Introduction

Wordplay

API for cheating at word games, written in Clojure.

Endpoints

All endpoints return pretty-printed JSON by default.

GET /words/:word

Get a serialized representation of a word resource

{
	"word" : wordplay",
	"game": "wwf"
	"length" : 8,
	"letters" : [ "w", "o", "r", "d", "p", "l" "a", "y" ],
	"is_valid" : true,
	"points": 17,
	"anagrams": [],
	"definition": ""
} 

Query parameters:

Parameter Optional? Description
game yes The alias of the board game to look the word up in. See Supported Games for more info

GET /board

Get a board resource, with computed properties like best_move. Wordplay is stateless, so you must pass in all information about a board's state for each request.

{
	"tiles": [][],
	"rack": [],
	"game": "wwf",
	"best_move": {},
	"remaining_letters": [],
	"words": []	
}

Query parameters:

Parameter Optional? Description
game yes The alias of the board game to look the word up in. See Supported Games for more info
tiles no A 2D array ([row][column]) of tiles, each either one character or a blank denoted by "_".
rack yes A list of tiles in the player's rack. If empty, no "best_move" will be present.

Supported games

Game Alias Default?
Words with Friends wwf yes

Prerequisites

You will need Leiningen 1.7.0 or above installed.

Running

To start a web server for the application, run:

lein ring server

Future

Supported games:

  • Words with Friends/Scrabble
  • Crossword
  • Word ladder?

License

Copyright © 2014 Jonathan Goldsmith

wordplay's People

Contributors

goldsmith avatar

Stargazers

fred avatar

Watchers

James Cloos avatar  avatar  avatar

Forkers

fredatgithub

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.