What is a REST API? (2024)

An APIis a set of definitions and protocols for building and integrating application software.It’s sometimes referred to as a contract between aninformation provider and an information user—establishing the content required from the consumer (the call) and the content required by the producer (the response).For example, the API designfor a weather service could specify that the user supply a zip codeand that the producer reply with a 2-part answer, the first being the high temperature, and the second being the low.

In other words, if you want to interact with a computer or system to retrieve information or perform a function, an API helps you communicate what you want to that system so it can understandandfulfill the request.

You can think of an API as a mediator between the users or clients and the resources or web services they want to get. It’s also a way for an organization to share resources and information while maintaining security, control, and authentication—determining who gets access to what.

Another advantage of an API is that you don’t have to know the specifics of caching—how your resource is retrieved or where it comes from.

REST is a set of architectural constraints, not a protocol or a standard. API developers can implement REST in a variety of ways.

When a client request is made via a RESTful API, it transfers a representation of the state of the resource to the requester or endpoint. This information, or representation, is delivered in one of several formats via HTTP: JSON (Javascript Object Notation), HTML, XLT, Python, PHP, or plain text. JSON is the most generally popular file format to use because, despite its name, it’s language-agnostic, as well as readable by both humans and machines.

Something else to keep in mind:Headersand parameters are also important in theHTTP methodsof aRESTful API HTTP request, as they contain importantidentifierinformation as to the request'smetadata, authorization, uniform resource identifier (URI), caching, cookies, and more. There are requestheadersand responseheaders, each with their own HTTP connection information and status codes.

In order for an API to be considered RESTful, it has to conform to these criteria:

• A client-server architecture made up of clients, servers, and resources, with requests managed through HTTP.
• Stateless client-server communication, meaning no client information is stored between get requests and each request is separate and unconnected.
• Cacheable data that streamlines client-server interactions.
• A uniform interface between components so that information is transferred in a standardform. This requires that:
  • resources requested are identifiable and separate from the representations sent to the client.
  • resources can be manipulated by the client via the representation they receive because the representation contains enough information to do so.
  • self-descriptive messages returned to the client have enough information to describe how the client should process it.
  • hypertext/hypermedia is available, meaning that after accessing a resourcethe client should be able to use hyperlinks to find all other currently available actions they can take.
• A layered system that organizes each type of server (those responsible for security, load-balancing, etc.) involved the retrieval of requested information into hierarchies, invisibletothe client.
• Code-on-demand (optional): the ability to send executable code from the server to the client when requested, extending client functionality.

Though the REST API has these criteria to conform to, it is still considered easier to use than a prescribed protocol like SOAP (Simple Object Access Protocol), which has specific requirements like XML messaging, and built-in security and transaction compliance that make it slower and heavier.

In contrast, REST is a set of guidelines that can be implementedas needed, making REST APIs faster and more lightweight, with increased scalablity—perfect for Internet of Things (IoT) and mobile app development.

Red Hat® Integration is an API-centric solution that provides application connectivity and data transformation, service composition and orchestration, real-time message streaming, change data capture, and API management all in one place to connect applications and data across a hybrid infrastructure. It’s combined with a cloud-native platform and toolchain to support modern app development.

Red Hat 3scale API Management is a component of Red Hat Integration, and helps you share, distribute, control, and monetize your APIs on an infrastructure platform built for performance, control, security, and growth. Place 3scale components on-premise, in the cloud, or both.