sameerkumar18 / geek-joke-api

Random Geek Jokes REST API

Geek-Jokes

A RESTful API to get random geek jokes written in Flask

What is the Geek-Jokes-api?

The Geek Jokes RESTful API lets you fetch a random geeky/programming related joke for use in all sorts of applications.

Why the Geek-Jokes-api?

The Geek Jokes api is for any developer needing some random (geeky) jokes in their life or application.

URL

GET: https://geek-jokes.sameerkumar.website/api?format=json

Usage

Just do a GET request on the API URL.

GET: https://geek-jokes.sameerkumar.website/api?format=json

Projects using Geek Jokes API

Repository	Description
Random. Django. Rango.	Random. Django. Rango. An introduction to using Python and Django to build a website.
tellmejoke	VS Code Extension that tells you a joke

Used Geek Jokes API in your project? Check out the contributing guidelines for this list and let us know. we love PRs :)

Examples

cURL

curl -X GET \
'https://geek-jokes.sameerkumar.website/api?format=json'

Python

import requests

requests.get('https://geek-jokes.sameerkumar.website/api?format=json')

Node.js (es6)

var request = require('request');

let options = {
    url: 'https://geek-jokes.sameerkumar.website/api?format=json',
    method: 'GET'
}

request(options, (err, response, body) => {
    if(!err && response.statusCode == 200)
        console.log(body)
});

Any browser

visit the url: https://geek-jokes.sameerkumar.website/api?format=json to get a joke. Press refresh button for more jokes.

License

MIT

Contact

Contact: [email protected]

Author

Sameer Kumar https://sameerkumar.website

geek-joke-api's Issues

Webapp using API

I would like to create a web application using this API. But Jokes are lame :/ .

Remove Binary files and add gitignore

Hi, I opened #26 to suggest removing the .pyc file from your repo. This is a compiled file which shouldn't need to be versioned, and best practice is not to include files like this in your repos. The addition of the .gitignore will keep it from being added in future pushes. There are also some other best practice examples listed in the .gitignore as well. Please let me know what you think.

No 'Access-Control-Allow-Origin'

Failed to load https://geek-jokes.sameerkumar.website/api: No 'Access-Control-Allow-Origin' header is present on the requested resource. Origin 'http://localhost:4200' is therefore not allowed access.

---

Angular 6
HttpClient
default HttpGet
Other api-s work

Improve code

I wrote this code about 4 months ago when I was trying to implement REST in Flask API.
I think the code can be improved a lot.

I/O Operation while processing request

It is a bad practice to perform any I/O operation while processing request so print joke statement should be removed.

Write documentation for the API

It'll be great if someone could write the documentation for the API.
I wrote docs for an API previously, for reference - https://github.com/sameerkumar18/aztro/blob/master/docs/source/index.rst

Add geek jokes to file

I think the API needs more jokes. Currently, there are around 500 or so.
You can add geek jokes in the .json file.

(Do add the reference to the source in description of the pull request, if you're taking the content(joke) from somewhere else)