Reviewer Instructions

If you are reviewing this submission, then you can do so in two ways

• Look at the changes in this pull request
• Browse the code on Github

GitHub gist API

This is an example interface for GitHub API. Using this tool you will be able to view publicly available gists for a user.

This repository contains the Python API code and Docker file required to get the tool up and running.

Building and Running a container

1. Clone the GitHub repo:

   git clone https://github.com/EqualExperts-Assignments/equal-experts-innovative-distinguished-fortunate-equilibrium-b4db1f1bc7cd.git
   

2. Navigate inside the directory

   cd equal-experts-innovative-distinguished-fortunate-equilibrium-b4db1f1bc7cd
   

3. Run the following command to build the image:

   docker build -t <username>/<imagename> .
   

4. Run the following command to start the containers:

   docker run -n gist-api -p 8080:8080 -itd <username>/<imagename>
   

Access API

You can now try the API endpoints

1. Swagger documentation

   curl -v http://localhost:8080/docs     
   

2. Get gists for an userid

   curl -v http://localhost:8080/<userid>