Fans of IBM Z Hub

Fans of IBM Z Hub

Fans of IBM Z Hub

Join us and share the love of IBM Z with our global community!

 View Only

what makes an API “RESTful”?

By Hamid Khan posted 02/26/24 01:27 PM

  

REST (Representational State Transfer) is an architectural programming style that provides a simple and intuitive programming design for developers to access and update data over the internet. It uses HTTP as a protocol for data transfer, but not all HTTP interfaces are "RESTful". With REST, developers can easily access and manipulate data without having to worry about the underlying technology. If you are a developer looking for a simple and effective way to access and manipulate data, REST is the way to go!

REST architectural style of development follow these basic principles.

  • It should be stateless (transaction management should be managed by the client)
  • It should access and/or identify all server resources using only a single URI.
  • It should use the HTTP methods, GET, POST, PUT, DELETE for performing CRUD operations.
  • It should return the result only in the form of consistent and simple JSON


When a REST API follows these basic principles, it is considered a RESTful API, whereas a REST API only follows some but not all the above principles.

Accessing a z/OS resource with an API

You can create your APIs using the Eclipse Tooling to generate a service archive file for the z/OS application.

Note: All service archives files are functionally equivalent regardless of how there are created or which resources they are intended to access

                                  Eclipse z/OS Connect API Toolkit

  Eclipse API Toolkit

 API Toolkit provides additional data mapping. Use the editor to describe the API and how it maps to undelying services. It also adds logic to interpret the results to add support for multiple HTTP response code.

1 comment
29 views

Permalink

Comments

03/14/24 10:22 AM

Thank you.