Improved client experience

Oct 13, 2025 by miodeya.com 135 views

Introduction

In this article, we will discuss the improvement of the Revision API in a backend system. The current implementation of the Revision API returns a 404 Not Found error when a request is made to retrieve a non-existent revision. However, this behavior is not desirable in certain scenarios, such as when a client is synced with a specific revision and wants to check if there is a new revision available on the server. In this case, the client expects the API to return the current revision, even if it is not the latest one. In this article, we will explore the reasons behind this improvement and provide a solution to achieve this behavior.

Problem Statement

The current implementation of the Revision API returns a 404 Not Found error when a request is made to retrieve a non-existent revision. This behavior is not desirable in certain scenarios, such as when a client is synced with a specific revision and wants to check if there is a new revision available on the server. In this case, the client expects the API to return the current revision, even if it is not the latest one.

Use Case

Let's consider a use case where a client is synced with revision 720. The client wants to check if there is a new revision available on the server by making a request to api/revision/721. However, if there is no new revision, the current implementation of the Revision API returns a 404 Not Found error. This is not the expected behavior, as the client expects the API to return the current revision, even if it is not the latest one.

Expected Behavior

The expected behavior is for the Revision API to return the current revision, even if it is not the latest one. In this case, the API should return the following JSON:

{
  "id": "c9b1d7dd-e83e-4600-9237-35c24449aa69",
  "version": 720,
  "added": {},
  "deleted": []
}

Solution

To achieve this behavior, we need to modify the Revision API to return an empty object with the current revision when a request is made to retrieve a non-existent revision. This can be achieved by adding a check in the API to see if the revision exists. If it does not exist, the API should return an empty object with the current revision.

Implementation

Here is an example of how the modified Revision API can be implemented:

@RestController
@RequestMapping("/api/revision")
public class RevisionController {

    @GetMapping("/{revision}")
    public Revision getRevision(@PathVariable Long revision) {
        Revision currentRevision = revisionService.getRevision(revision);
        if (currentRevision == null) {
            // Return an empty object with the current revision
            Revision emptyRevision = new Revision();
            emptyRevision.setId("c9b1d7dd-e83e-4600-9237-35c24449aa69");
            emptyRevision.setVersion(720);
            emptyRevision.setAdded(Collections.emptyMap());
            emptyRevision.setDeleted(Collections.emptyList());
            return emptyRevision;
        } else {
            return currentRevision;
        }
    }
}

Benefits

The modified Revision API provides several benefits, including:

Improved client experience: The client can now check if there is a new revision available on the server without having to worry about the API returning a 404 Not Found error.
Simplified client code: The client can now simplify its code by assuming that the API will return the current revision, even if it is not the latest one.
Reduced errors: The modified API reduces the likelihood of errors occurring due to the API returning a 404 Not Found error.

Conclusion

Introduction

In our previous article, we discussed the improvement of the Revision API in a backend system. The modified API returns an empty object with the current revision when a request is made to retrieve a non-existent revision. In this article, we will answer some frequently asked questions (FAQs) about the modified Revision API.

Q: Why is the modified Revision API returning an empty object with the current revision?

A: The modified Revision API returns an empty object with the current revision to provide a better experience for clients. When a client is synced with a specific revision and wants to check if there is a new revision available on the server, the API should return the current revision, even if it is not the latest one. This behavior is expected by the client, and the modified API meets this expectation.

Q: What is the benefit of returning an empty object with the current revision?

A: The benefit of returning an empty object with the current revision is that it simplifies the client code and reduces the likelihood of errors occurring due to the API returning a 404 Not Found error. Additionally, it provides a better experience for clients, as they can now check if there is a new revision available on the server without having to worry about the API returning a 404 Not Found error.

Q: How does the modified Revision API handle requests for non-existent revisions?

A: The modified Revision API handles requests for non-existent revisions by checking if the revision exists. If the revision does not exist, the API returns an empty object with the current revision. If the revision exists, the API returns the revision as usual.

Q: Can the modified Revision API be used with other APIs that rely on the Revision API?

A: Yes, the modified Revision API can be used with other APIs that rely on the Revision API. The modified API is backward compatible with the previous implementation, so APIs that rely on the Revision API can continue to function as usual.

Q: How does the modified Revision API affect the performance of the system?

A: The modified Revision API does not affect the performance of the system. The API still performs the same operations as before, but it now returns an empty object with the current revision when a request is made to retrieve a non-existent revision.

Q: Can the modified Revision API be customized to meet specific requirements?

A: Yes, the modified Revision API can be customized to meet specific requirements. The API can be modified to return different data or to handle requests in a different way. Additionally, the API can be integrated with other systems or APIs to meet specific requirements.

Q: How can I implement the modified Revision API in my system?

A: To implement the modified Revision API in your system, you can follow these steps:

Modify the Revision API to return an empty object with the current revision when a request is made to retrieve a non-existent revision.
Update the client code to handle the new behavior of the Revision API.
Test the modified API to ensure that it functions as expected.

Conclusion

In conclusion, the modified Revision API provides a significant improvement over the current implementation. By returning an empty object with the current revision when a request is made to retrieve a non-existent revision, the API provides a better experience for clients and simplifies their code. The benefits of this modification include improved client experience, simplified client code, and reduced errors.