pitzzahh / jokes-API

API that generates random jokes

Home Page:https://jokes.araopj.tech

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Jokes API

API that generates random jokes based on some categories or just random


GitHub Issues Forks Stars License Forks Stars Contributors Last Commit Code size Top language Languages count Repo size


API Reference

Get a random joke and returns a JSON response from the API

Temporary link
 GET https://jokes.araopj.tech/v1/random

Example response

{
  "joke": "What do you call a fake noodle? An \"impasta\".",
  "category": "DAD_JOKE",
  "language": "ENGLISH"
}
{
  "joke": "Ano ang sabi ng isang kahoy sa ibang kahoy? Pakapit!",
  "category": "ONE_LINER",
  "language": "FILIPINO"
}

Get random joke based on category and language

 GET https://jokes.araopj.tech/v1/random?category=${category}&language=${language}
Parameter Type Description
category String Required. category of joke to fetch
language String Required. language of joke to fetch
Sample Request
 GET https://jokes.araopj.tech/v1/random?category=ANY&lang=FILIPINO

Get random joke based on category

 GET https://jokes.araopj.tech/v1/random?category=${category}
Parameter Type Description
category String Required. category of joke to fetch
Categories
available
ANY
DAD_JOKE
PUN
KNOCK_KNOCK
ONE_LINER

Sample Request

 GET https://jokes.araopj.tech/v1/random?category=DAD_JOKE

Get random joke based on language

 GET https://jokes.araopj.tech/v1/random?language=${language}
Parameter Type Description
language String Required. language of joke to fetch
Languages
available
ENGLISH
FILIPINO

Sample Request

 GET https://jokes.araopj.tech/v1/random?lang=FILIPINO

Contributing

Contributions are always welcome!

Have a joke in mind? Submit now!

 POST https://api.araopj.tech/api/v1/jokes/submit
Sample submission
{
  "joke": "What do you call a cow with no legs? Ground beef.",
  "category": "DAD_JOKE",
  "language": "ENGLISH"
}

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.


Features

  • Random joke
  • Many joke categories
  • Many joke languages
  • Random joke based on category
  • Random joke based on language
  • Random joke based on category and language
  • API Documentation
  • API Rate Limiting
  • API Authentication
  • API Key
  • Microservice (? maybe)

Support

For support, email pitzzahh@araopj.tech


License

MIT

🤍 Special Thanks to railway for providing free hosting for this project

About

API that generates random jokes

https://jokes.araopj.tech

License:MIT License


Languages

Language:Java 60.7%Language:HTML 18.0%Language:SCSS 8.6%Language:CSS 7.8%Language:JavaScript 4.3%Language:Dockerfile 0.6%