Skip to content
/ drae Public

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

License

Notifications You must be signed in to change notification settings

squat/drae

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Drae

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

Build Status Go Report Card

Running

The easiest way to use drae is with the prebuilt container:

$ docker run -p 4000:4000 squat/drae

or if you wish to install drae locally:

$ go get -u github.com/squat/drae/cmd/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 api --port=6969

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:4000/api/gato.

/healthz

The /healthz endpoint returns a 200 if the API is running.

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published