What API's Are About by Postman

Lakshya — Mon, 27 Jun 2022 10:22:51 +0000

A few days ago I attended Postman's API 101 Workshop. This is an industry talk that the folks at Postman deliver at universities as part of their Student Program. And here's all that I learned:

First of all, Postman itself is not an API, as some of my classmates mistook it as, instead Postman is an application that is used to build APIs.

API stands for Application Programming Interface. That may not make much sense so let's leave it aside for now. We'll get back to that later.

The Modern-day Application

For now, let's look at a typical modern day web application. There are broadly two sides to it. The first is the thing we, as users, see. The webpages, the graphical interface with all the pretty buttons and illustrations, and all the fancy animations. This is called the front-end of your website. This is where you would provide any inputs and be able to view the output.

Now, the existence of this front-end implies that there must also exist a back-end. And it does!

The back-end of any app is the actual logic and the code that makes it behave like it's supposed to. All the heavy lifting behind the scenes that you, as a user of that app, might not see is happening here. Hence, the term back-end. This is where the inputs from the front-end are processed and an output is sent back to be displayed.

It's like going to a restaurant!

The expert at the workshop explains this with a brilliant analogy of a restaurant. When you go to a restaurant, the menu or the tables or the beautiful decor of the place is the front-end. But all the real work - cooking of the food - happens in the kitchen that you may not see. Hence, the kitchen is the back-end.

To APIs...

So far so good. Now naturally there must also exist a way through which these two sides communicate. Because how else would the front-end take your inputs to the back-end for processing, or bring back the output so you can see it?

At a restaurant, you yourself don't go to the kitchen and bring your order back from the chefs, right? That's what waiters are for! And that's exactly what APIs do too!

Waiters take your order details and relay it to the kitchen so the chefs can cook it up. And when they're done, waiters bring back the delicious cooked food back to your table as requested by you. Much like how APIs collect your inputs from the front-end via a request and relay it to the back-end where the inputs get processed and certain output is returned back to you as a response!

Enough about restaurants, how does it work in real life?

These requests and responses usually take place over HTTP in a real-world application. The front-end makes an HTTP request with the inputs in its request body at a certain API endpoint and is returned an output in a form of an HTTP response with a certain response body.

There are different kinds of HTTP requests that mean different things:

The GET HTTP request method means that you want to receive some data.
The POST HTTP method means that you also want to send some data.
The PUT method means you want to update certain data.
The DELETE method means you want to delete certain data.

These four kinds of requests come together to make a CRUD based API. This kind of API architecture is commonly called a REST API and the API is said to be RESTful.

OK, but why API?

There are literally thousands of APIs out there. A big advantage of using them is that you don't necessarily need to know the back-end logic yourself. As long as you know what data to input and what to expect in the output, you can totally use an API to do all the processing for you.

Since these API provide almost like an interface over some abstract logic code, they are said to be a layer of abstraction. And the different endpoints provide an interface to interact with the real code. All the developer needs to know is how to interact with this interface.

Hence the full form, i.e., Application Programming Interface. As they are nothing but an interface that can help you program your application by taking care of all the third-party logic.

So that's about it. The instructor of the workshop made us do all of this hands-on using Postman on a dummy jokes API. And you can interact with it too here: http://postman-student.herokuapp.com/joke/

Nutshell: Summarise your recorded online lectures in a few minutes!

Lakshya — Thu, 07 Apr 2022 05:38:32 +0000

Note: This is my submission for the Deepgram x DEV hackathon.

Presenting... Nutshell 💥

Overview of My Submission

Nutshell allows students to quickly summarise their entire video lectures in just a few minutes. Whether it's for a quick revision, catching up on missed classes, or simply a reference for what happened, Nutshell helps students by providing them with the most important parts of the class without them having to watch a second of the recorded video.

And the best part is that it's not just limited to online lectures. Anyone in need of summarising a video-based session can make use of Nutshell and get all the meat. Be it online conferences, meetings, presentations, seminars, or workshops, you just have to upload the recorded video with clear audio, and Nutshell takes care of the rest.

Nutshell leverages state-of-the-art, open-source machine learning & deep learning technologies in order to go from the original video to its short summed-up version. This allows us to provide the user with a concise, accurate and reliable summary.

GitHub: https://github.com/outoflaksh/nutshell

How was Deepgram 🎙️ used?

The basic flow that Nutshell follows to accomplish its goals is as follows:
Step 1. Convert the uploaded video into audio.
Step 2. Transcribe the extracted audio.
Step 3. Run a summarising algorithm on the received transcription.

As is evident, Deepgram comes into play for the second and perhaps the most crucial step in the process, that is, to convert the lecture's audio into text.

📊 Results

To see if it works, we (my friend and I) decided to submit this video to Nutshell. It's a roughly 9 minute long YouTube video explaining the concept of HTTP.

Following was the retrieved summary:

When we mention the Http, that means we need to talk about how the web works, at least having a general idea. And if two computers want to communicate an exchange data, name lay the client and the server usually in form of a request response cycle, those two computers must speak both of them the Http communication protocol. Now before talking about the how and the why, you need to know three important things about the Http protocol. When the connection establishes the client sends a request called an Http message. And because the Http is a connection protocol, the client disconnects from the server waiting for the response. The information in the sections vary dependent on the http message, whether it is a request or a response. First, let's look at request http message. The header specify some information in rules, for example, the host, which is the address of the server to which we are sending the request, which is w w w dot my website dot corn. Let's talk now about a response http message. Also, our clients can send multiple http requests to the server. We've seen that the request response cycle works on the web via http messages.

DEV Community: Lakshya