Snapper

A Web microservice for capturing a website's OpenGraph data built in Golang

Building Snapper

building the binary

git clone https://github.com/owl-93/snapper
cd snapper
go build .

optionally give the executable a name

go build -o <executable name> .

Running Snapper

./snapper

Specifying a different port

you can tell snapper to use a different port by passing the port as a comman line argument

./snapper 8081

By default, snapper runs on port 8888

Using Snapper

To snap a webpage's Opengraph metadata, just make a REST POST request to / with the target website specified in the request body using the key page. You can optionally pass the forceRefresh option in the request body to force snapper to fetch the latest metadata and not use any cached values if present.

Example

curl --location --request POST 'http://localhost:8888/' 
--header 'Content-Type: application/json' 
--data-raw '{
    "page": "https://code.visualstudio.com/download",
    "forceRefresh" : true
}'

Response

[
    {
        "name": "og:title",
        "value": "Download Visual Studio Code - Mac, Linux, Windows"
    },
    {
        "name": "og:description",
        "value": "Visual Studio Code is free and available on your favorite platform - Linux, macOS, and Windows.  Download Visual Studio Code to experience a redefined code editor,  optimized for building and debugging modern web and cloud applications."
    },
    {
        "name": "og:image",
        "value": "https://code.visualstudio.com/opengraphimg/opengraph-home.png"
    },
    {
        "name": "og:url",
        "value": "https://code.visualstudio.com/Download"
    }
]