Skip to content

[Imported] REST section improvement #441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

[Imported] REST section improvement #441

wants to merge 7 commits into from

Conversation

ido777
Copy link
Owner

@ido777 ido777 commented Apr 6, 2025

Imported from donnemartin/system-design-primer#404

Original author: @Roger13


Changed some references, definitions and disadvantages, and removed a misconception.
Changes are:

  • Fix HATEOAS reference and definition
  • Fix REST hierarchy disadvantage
  • Removed verb misconcenption
  • Add workaround to complex single view problem
  • Rewrote resource change problem

Rogerio Bernardo added 6 commits April 19, 2020 12:48
Previous reference and definition wrongly assumed HTML as mandatory for HATEOAS, where in fact Hypermedia is.
Previous definition assumed rest is only suited for simple hierarchies and presented a use case which can be easily  expressed through query params or even an 'action' from a resource

Replaced it with the indeed requisite for designing APIs, which is a solid understanding of the business, so relationships are well expressed.
If an action outside CRUD is needed for a specific resource, it is usually expressed with an POST to an action. For instance, the previous example could be modelled as:

POST /documents/archieveExpired
Add a more broad view of the problem derived from changing entities and business understanding evolving. Also add common workarounds.
@Copilot Copilot AI review requested due to automatic review settings April 6, 2025 20:40
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

anandfresh pushed a commit that referenced this pull request Apr 22, 2025
* ja-Translation: Follows #433

* ja-Translation: Follows #350

* ja-Translation: Follows #348

* ja-Translation: Follows #439

* ja-Translation: Follows #351

* ja-Translation: Follows #411

* ja-Translation: Follows #328

* ja-Translation: Follows #441, #108

* ja-Translation: Follows #400

* ja-Translation: Follows #321

* Update README-ja.md

---------

Co-authored-by: Ryo Shibayama <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants