API Quick Reference
HTTP Verbs
┣ GET : Retrieve data from the server
┣ POST : Send data to the server to create a resource
┣ PUT : Send data to the server to update a resource
┣ PATCH : Send data to the server to update a resource partially
┗ DELETE : Delete a resource from the server
┣ TRACE : Returns the full HTTP request received by the server for
debugging and diagnostic purposes
┣ OPTIONS : Returns the HTTP methods supported by the server for the
requested URL
┣ CONNECT : Converts the request connection to a transparent TCP/IP
tunnel for secure communication
┗ PURGE : Invalidates a cached resource
┣ LOCK : Locks the resource for exclusive use by the client
┣ UNLOCK : Unlocks the resource previously locked by the client
┣ MKCOL : Creates a new collection resource
┗ COPY : Copies the resource identified by the Request-URI to the
destination URI.
HTTP Status Codes
┣ 1xx : Informational
┣ 2xx : Success
┣ 3xx : Redirection
┣ 4xx : Client Errors
┗ 5xx : Server Errors
By: Waleed Mousa
, API Quick Reference
Response Headers
┣ Content-Type : Specifies the MIME type of the data in the response
body
┣ Content-Length : Specifies the length of the response body in bytes
┣ Cache-Control : Specifies the caching behavior of the response
┣ Location : Specifies the URI of a resource that can be used to
retrieve the requested resource
┣ Server : Specifies the name and version of the server software that
generated the response
┣ Access-Control-Allow-Origin : Specifies which origins are allowed to
access the resource
┣ Set-Cookie : Specifies a cookie that should be stored by the client
and sent back to the server with future requests
┣ Expires : Specifies the date and time after which the response is
considered stale
┗ Last-Modified : Specifies the date and time the resource was last
modified.
API Design
┣ REST : Representational State Transfer, a design pattern for
building web services
┣ SOAP : Simple Object Access Protocol, a messaging protocol for
exchanging structured data
┣ GraphQL : A query language and runtime for building APIs
┗ API Gateway : A service that manages, protects, and scales APIs
By: Waleed Mousa
HTTP Verbs
┣ GET : Retrieve data from the server
┣ POST : Send data to the server to create a resource
┣ PUT : Send data to the server to update a resource
┣ PATCH : Send data to the server to update a resource partially
┗ DELETE : Delete a resource from the server
┣ TRACE : Returns the full HTTP request received by the server for
debugging and diagnostic purposes
┣ OPTIONS : Returns the HTTP methods supported by the server for the
requested URL
┣ CONNECT : Converts the request connection to a transparent TCP/IP
tunnel for secure communication
┗ PURGE : Invalidates a cached resource
┣ LOCK : Locks the resource for exclusive use by the client
┣ UNLOCK : Unlocks the resource previously locked by the client
┣ MKCOL : Creates a new collection resource
┗ COPY : Copies the resource identified by the Request-URI to the
destination URI.
HTTP Status Codes
┣ 1xx : Informational
┣ 2xx : Success
┣ 3xx : Redirection
┣ 4xx : Client Errors
┗ 5xx : Server Errors
By: Waleed Mousa
, API Quick Reference
Response Headers
┣ Content-Type : Specifies the MIME type of the data in the response
body
┣ Content-Length : Specifies the length of the response body in bytes
┣ Cache-Control : Specifies the caching behavior of the response
┣ Location : Specifies the URI of a resource that can be used to
retrieve the requested resource
┣ Server : Specifies the name and version of the server software that
generated the response
┣ Access-Control-Allow-Origin : Specifies which origins are allowed to
access the resource
┣ Set-Cookie : Specifies a cookie that should be stored by the client
and sent back to the server with future requests
┣ Expires : Specifies the date and time after which the response is
considered stale
┗ Last-Modified : Specifies the date and time the resource was last
modified.
API Design
┣ REST : Representational State Transfer, a design pattern for
building web services
┣ SOAP : Simple Object Access Protocol, a messaging protocol for
exchanging structured data
┣ GraphQL : A query language and runtime for building APIs
┗ API Gateway : A service that manages, protects, and scales APIs
By: Waleed Mousa
