hakumennc/imgflip-api

REST API for Imgflip

imgflip-api

❔ About

This an unofficial API attempt for Imgflip. I'm a big fan of Imgflip community and wanted to have a custom and richer API than the official one, also for example, with Swagger documentation., the ability to run in as a container, etc...

This API should open a variety of fun usages around Imgflip.

🚀 Getting Started

💻 Build and run API locally

git clone https://github.com/adriens/imgflip-api.git
cd imgflip-api
mvn spring-boot:run

🐳 Docker image is coming soon.

📚 Documentation

Swagger

Go to http://localhost:8080/

📑 Endpoint samples

Meme templates

• Memes : http://localhost:8080/memes

$ http :8080/memes/
HTTP/1.1 200
Content-Type: application/json

[
    {
        "box_count": 2,
        "height": 1200,
        "id": 181913649,
        "name": "Drake Hotline Bling",
        "url": "https://i.imgflip.com/30b1gx.jpg",
        "width": 1200
    },
    ...
]

• Get the top 10 meme templates : http://localhost:8080/memes/top/10/

$ http :8080/memes/top/3
HTTP/1.1 200
Content-Type: application/json

[
    {
        "box_count": 2,
        "height": 1200,
        "id": 181913649,
        "name": "Drake Hotline Bling",
        "url": "https://i.imgflip.com/30b1gx.jpg",
        "width": 1200
    },
    {
        "box_count": 3,
        "height": 908,
        "id": 87743020,
        "name": "Two Buttons",
        "url": "https://i.imgflip.com/1g8my4.jpg",
        "width": 600
    },
    {
        "box_count": 3,
        "height": 800,
        "id": 112126428,
        "name": "Distracted Boyfriend",
        "url": "https://i.imgflip.com/1ur9b0.jpg",
        "width": 1200
    }
]

• Get Meme by ID : http://localhost:8080/memes/112126428/

$ http :8080/memes/112126428
HTTP/1.1 200
Content-Type: application/json

{
    "box_count": 3,
    "height": 800,
    "id": 112126428,
    "name": "Distracted Boyfriend",
    "url": "https://i.imgflip.com/1ur9b0.jpg",
    "width": 1200
}

Published memes

• Get hot politics memes : http://localhost:8080/hot/politics?page=2

$ http :8080/hot/gaming?page=2
HTTP/1.1 200
Content-Type: application/json

[
    {
        "author": "VinceVance",
        "authorPath": "/user/VinceVance",
        "imageUrl": "https://i.imgflip.com/5jbb6n.jpg",
        "memeUrl": "https://imgflip.com/i/5jbb6n",
        "mp4Url": null,
        "posterUrl": null,
        "rawScore": null,
        "score": {
            "nbComments": 3,
            "nbUpvotes": 38,
            "nbViews": 378
        },
        "title": "The millions we make here in the USA isn't enough...",
        "webmUrl": null
    },
    ...
]