diogotorres97 / ditado-api

Public API to serve ditados, i.e., popular portuguese sayings.

Home Page:http://ditados-api.herokuapp.com/ditados

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ditado-api

Public API to serve ditados, i.e., popular Portuguese sayings.

Why?

Github Actions had just came out and I wanted to learn all about it, namely how to automate deployments via Heroku. Fetching ditados seemed like the perfect excuse. Also inspired by this.

API

Public REST API available at https://ditado-api.herokuapp.com.

  • GET /ditados - Fetch all entries
  • GET /ditados/random - Fetch random entry. Take on this issue!

Contribute

  • Fork this repo and edit ditados.json;
  • Add a ditado, including what it means under the meaning field:
{
   "ditados":[
      (...)
      {
         "content":"Your ditado",
         "meaning":"What it means"
      }
   ]
}
  • Submit a PR and celebrate 🎉

About

Public API to serve ditados, i.e., popular portuguese sayings.

http://ditados-api.herokuapp.com/ditados

License:MIT License


Languages

Language:JavaScript 72.9%Language:Dockerfile 27.1%