Giter VIP home page Giter VIP logo

drae's Introduction

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.

drae's People

Contributors

squat avatar grenderg avatar

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.