request rest api code example

Example 1: api request

Request 
		 Request URL (ENDPOINT)
		 	http://54.158.178.13:8000/api/spartans

		 HTTP Methods|Verb  : GET POST PUT DELETE PATCH 
		 	
		 HEADER  : key value pair 
		 	Accept , Content-Type
		 
		 Query Parameters : key value pair right after ? 
		 	/api/spartans/search?gender=Male&nameContains=li
		 	mostly used to filter out the result according to 
		 	the cirteria provided here 

		 Path Parameters|Variable 
		 	/api/spartans/{id}  /api/spartans/:id
		 	used to identify single resource among list of resources

		 Request Body | Payload
		 	the data you are sending to the server

Example 2: request api

REQUEST :(request url,http methods,header,query param, param,body,cookie)

1-)Request Url where we have Endpoint (domain:Port/Endpoints)

2-)HTTP METHODS(Get, Post, Put, Patch, Delete, Header)

Get: For to retrieve resources from the server
Post: to send or add resource to the server
Put: For update the resources in the server
Patch: For partial update the resource
Delete: For deleting the resource in the server
Head: To get header from the response not the body

3-)HEADER is metadata is about the request,
basically providing more information along
with the request.

-Content Type header : to specify what kind of
 data we are sending to the server
-Accept Header : to specify what kind of data 
 format you want to get in the response like (json or xml)
-Authorization header : used to provide the
 Bearer token in many api's.

4-)Query Parameter: A key value pair usually
 for filtering result

5-)Parameter: for identifying single resource
 among the list of resources.
6-)Payload(BODY): for POST,PUT,PATCH request
(json,xml,plainText,URL encoded for data)
7-)Cookie

Example 3: rest api

Representational state transfer is a software architectural style that defines
a set of constraints to be used for creating Web services.

Web services that conform to the REST architectural style, called RESTful Web
services, provide interoperability between computer systems on the internet

Example 4: rest api

1) REQUEST
2) RESPONSE
When we send request, we need to know the API
methods/endpoints that are available:
		- read documentation about API methods.
		- Swagger tool, that has API methods and descriptions
simple endpoint:
		…school.com/api/students
Types of Requests:
	GET -> Read data
	POST -> Create/insert data
	PUT -> Update data
	DELETE-> Delete data
I send GET, POST, PUT, DELETE type of API requests to
API endpoint/method and get response.
ORDS (oracle data service) API -> HR Database
ORDS API has methods that we can send request to, and it sends
response with Data from HR database.