API TERMINOLOGY : Part-1

-

API TERMINOLOGY



Q1: What is a Resource?

Resource is a physical or virtual component, which supports/extends/represents/constructs a system. Consider a real time example of a Vehicle . Wheels, brakes, headlight, fuel tank etc all are resources of a Vehicle  . All resources have names, location and identifiers.

Take another example of Google. Now append “/gmail” in the last of the base url “https://www.google.com/” as "https://www.google.com/gmail". 

Google will launch Gmail Page:

   https://www.google.com

Base URL:  https://www.google.com  

Resource: /gmail/about/# 

Q2: What are Collections?

  • Collections are simply groups of resources. You’ll find that we don’t mention any collections in the API documentation.
  • That is because we offer singleton resources, which are independent and exist outside of any collections


Q3: What is Endpoints/BaseUrl?

  • API endpoint is the point of entry in a communication channel when two systems are interacting.  It refers to touchpoints of the communication between an API and a server.
  • The endpoint can be viewed as the means from which the API can access the resources they need from a server to perform their task.

  • An API endpoint is basically a fancy word for a URL of a server or service.

Endpoints: https://www.google.com/gmail/about/#


  • HTTP METHODS:

  • GET

  • PUT

  • POST

  • DELETE

  • PATCH


Please find the video of  API TERMINOLOGY : Part-1

THANKS


Comments

Post a Comment

Popular posts from this blog

Python namespaces & LEGB rule in Python

-
Image
What are Python namespaces? What is the LEGB rule in Python? A namespace in Python ensures that object names in a program are unique and can be used without any conflict. Python implements these namespaces as dictionaries with 'name as key' mapped to a corresponding 'object as value'. This allows for multiple namespaces to use the same name and map it to a separate object. A few examples of namespaces are as follows: Local Namespace  includes local names inside a function. the namespace is temporarily created for a function call and gets cleared when the function returns. Global Namespace  includes names from various imported packages/ modules that are being used in the current project. This namespace is created when the package is imported in the script and lasts until the execution of the script. Built-in Namespace  includes built-in functions of core Python and built-in names for various types of exceptions. The  lifecycle of a namespace  depends upon the sco...
Read more