Zasady projektowania RESTful API

Welcome! In this lesson, we'll explore RESTful API design principles. REST stands for REpresentational State Transfer, a set of architectural principles for designing networked applications.

For a SaaS product, a well-designed RESTful API is crucial for:

• Scalability: Handling many users and requests.
• Maintainability: Easy to understand and update.
• Interoperability: Works well with different clients (web, mobile).

The core idea of REST is to focus on resources. Think of resources as the 'nouns' of your application, like users, products, orders, or subscriptions.

Instead of thinking about actions (e.g., getUser, createProduct), think about the data itself. Each resource should have a unique identifier.

• Good: /users, /products
• Avoid: /getAllUsers, /createProduct

Each resource or collection of resources is identified by a Uniform Resource Identifier (URI). These are essentially the URLs your API clients will call.

URIs should be:

• Clear & Intuitive: Reflect the resource.
• Hierarchical: Show relationships (e.g., /users/123/orders).
• Plural Nouns: Use plural nouns for collections (e.g., /products).

Example URI structure:

Once you have identified your resources and their URIs, you need ways to interact with them. This is where HTTP methods (also called verbs) come in.

REST uses standard HTTP methods to perform operations on resources, mapping directly to common CRUD (Create, Read, Update, Delete) actions:

• GET: Retrieve data
• POST: Create new data
• PUT: Update existing data (full replacement)
• PATCH: Update existing data (partial modification)
• DELETE: Remove data

The GET method is used to retrieve data from the server. It should never change the state of the resource on the server.

It's considered a 'safe' and 'idempotent' operation. This means calling it multiple times will produce the same result and won't cause side effects.

Try running this simple Java code to see how a GET request to retrieve a product might be conceptually handled:

The POST method is used to create new resources on the server. When you send a POST request, you typically include the data for the new resource in the request body.

Unlike GET, POST is not idempotent. Sending the same POST request multiple times might create multiple new resources (e.g., duplicate orders).

Here's a conceptual Java example demonstrating a POST request to create a new product:

PUT and DELETE are used for updating and removing resources, respectively.

• PUT: Replaces an entire resource with the data provided in the request body. It's idempotent; sending the same PUT request multiple times has the same effect as sending it once.
• DELETE: Removes the resource specified by the URI. It's also idempotent.

For partial updates, the PATCH method is often used, sending only the fields that need to be changed.

A key REST principle is statelessness. This means each request from a client to the server must contain all the information needed to understand the request.

The server should not store any client context between requests. It shouldn't 'remember' previous interactions for future requests.

Why is this important?

• Scalability: Easier to scale by adding more servers.
• Reliability: Less prone to errors if a server fails.
• Simplicity: Each request is self-contained.

When clients and servers exchange data in a RESTful API, they need a common format. JSON (JavaScript Object Notation) has become the de-facto standard.

JSON is lightweight, human-readable, and easily parsed by machines. It's much simpler than XML for most use cases.

Example of a typical JSON response:

As your SaaS product grows, your API will evolve. You'll add new features, change existing ones, or even remove old ones. To manage these changes without breaking existing client applications, API versioning is essential.

A common and recommended approach is URI versioning, where the version number is included directly in the URI path:

• /api/v1/users
• /api/v2/users

This allows clients to choose which version of the API they want to interact with.

Which of the following are core principles of RESTful API design?

Great job! You've now grasped the fundamental principles of RESTful API design:

• APIs are built around resources.
• Resources are accessed via unique URIs.
• HTTP methods define actions on resources.
• APIs should be stateless.
• JSON is the preferred data format.
• Versioning is crucial for API evolution.

In the next lesson, we'll apply these principles as we design our database schema and integrate an ORM to manage our data.