Giter VIP home page Giter VIP logo

indian-jokes-api's Introduction

Indian Jokes API

This is the repository of the indian-jokes-api live here.

Note - I make no claim on ownership of these files, nor do I necessarily endorse the jokes in them. This api is provided for fun purposes.

Supported API endpoints

Base URL -> https://indian-jokes-api.herokuapp.com

Endpoint Method Description
/categories GET Get a list of supported categories along with their IDs
/categories/{id} GET Get a specific category using the ID.
/categories/{id}/jokes GET Get all jokes of that category
/categories/{id}/jokes/random GET Get a random joke of that category
/jokes GET Get a list of all the jokes
/jokes/random GET Get a random joke
/jokes/{id} GET Get a specific joke using the ID.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Updating the database

If you want, you may include a scrapper or any source that you used to get the jokes from. If you want to add a scrapper, add it to the scrapper folder with name <category>.py.

To include the jokes in the database:

  • Create a file in the server/src/main/resources/ folder with name <category>.txt.
  • Add an entry in the jokes_meta.txt file as <above-created-file>.txt.

PS - Classic indian jokes preferred :p

License

This project is licensed under the MIT License - see the LICENSE file for details.

indian-jokes-api's People

Contributors

mayank8318 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.