README.md

Instructions for Implementing Image Microservice (CS3561)

This Microservice uses HTTP to receive a title of a Wikipedia article and return the url to the main thumbnail image.

Article Titles must be entered exactly (e.g. 'Golden State Warriors" and not "warriors")

Example implementation below is in Node.js/Expresss.

Setup

1. Install axios dependency:

   npm install axios
   

2. In app.js of main app, write:

   const axios = require('axios');
   

3. In HTML file of any page that will call this microservice, write:

   <script src="https://unpkg.com/axios/dist/axios.min.js"></script>
   

Example Request

The Querying Program should include a call to the base URL + the title of the Wikipedia article as a query parameter, with words separated by underscores.

The base URL is: https://img-microservice-a1ed942a20eb.herokuapp.com/

So, a desired query to the "Golden State Warriors" Wikipedia page would append: Golden_State_Warriors

and the final queryable URL would be:

https://img-microservice-a1ed942a20eb.herokuapp.com/Golden_State_Warriors

Example Call Below Querying "Golden State Warriors"

async function fetchData() {
    try {
        title = "Golden State Warriors";
        title = title.split(' ').join('_');
        url = 'https://img-microservice-a1ed942a20eb.herokuapp.com/';
        url = url + title;

        const response = await axios.get(url);
        return response.data;

    } catch (error) {
        console.error('Error fetching data from microservice:', error);
    }
}

async function showImageURL() {
    const data = await fetchData();
    console.log(data);
    alert("Primary Image for Wikipedia Article on " + title + " : " + data);
}

Example Response

The Microservice Program will parse the Wikipedia article title from the request body, query the MediaWiki API, and send back a string containing the url of the primary image.

For example, the request containing the term "Golden State Warriors" will return the url to the image boxed in red below.

Example Response from Query to "Golden State Warriors"

https://upload.wikimedia.org/wikipedia/en/thumb/0/01/Golden_State_Warriors_logo.svg/250px-Golden_State_Warriors_logo.svg.png

UML Sequence Diagram