Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 789 Bytes

README.md

File metadata and controls

28 lines (21 loc) · 789 Bytes
Raw

#Drae A RESTful API for el Diccionario de la Real Academia Española

##Instalation

$ go get github.com/lsvx/drae

##Usage ###Define The define command does exactly what you would think: it accepts a string argument and returns a JSON object with the definition for that word.

$ drae define gato

###Api You can run a drae API server from your machine using the api command. By default, this server runs on port 4000, though this can be configured with the -port flag.

$ drae -port=6969 api

You can now open a browser and query the API at http://localhost:6969/api/.

###Endpoints ####/api/<word> The API has only one endpoint: /api/<word>. For example, I could search for the definition of gato at http://localhost:6969/api/gato.