Skip to main content

Posts

Showing posts from September, 2021

API Documentation Overview

 In this blog, we will explore an example of API documentation for one example function findNeedles(). findNeedles() Overview The purpose of the findNeedles() API takes two string parameters i.e. needles array and haystack and finds the total number of occurrences of each element in the needles array that are present in the haystack string. This function searches for only five words or less from the needles array and logs an error if more words are available in the needles array. The comparison is done by first splitting the haystack string using literals like backspace, tab space, single quote, and double quote etc into single elements and then looping over the needles array to find occurrences of these elements. Parameters This function takes following parameters: Name Type Description haystack String A string of any length needles String Array An array of words     Sample Code publi

SOAP Vs REST – An Overview

Both SOAP and REST provides an efficient means of communication through exchange of data between two applications using web services. Although both are unique in their approach, they score over each other depending upon their suitability in various use cases. What is SOAP? SOAP (Simple Object Access Protocol) is a platform agnostic web communication protocol that uses only XML to exchange data. It adheres to strict message structure of Envelop, Header, Body and Fault (error) that enhances security and uses http to communicate between different applications. What is REST? REST (Representational State Transfer) is an architectural style to exchange data through efficient utilization of resources accessed using a unique URI. REST rides on HTTP/HTTPS to exchange data and supports XML, HTML, plain text and JSON data for API requests and responses. SOAP Vs REST – Which One to Select Both SOAP and REST have their own architectural styles that are flexible, scalable, and fulfil var