Add Architecture section to README.md#1853
Merged
yegor256 merged 1 commit intojcabi:masterfrom May 7, 2026
Merged
Conversation
Adds an Architecture section that explains the six key design decisions: dual Rt/Mk implementation hierarchy, Smart decorator pattern, JSON-as-state model, Link-header pagination with Bulk caching, Wire-based HTTP composition, and XML-backed mock storage with Xembly.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
@yegor256, this pull request adds an Architecture section to
README.mdthat was previously missing.What was added
A new
## Architecturesection placed immediately before## How to contribute?, covering six key design decisions in jcabi-github:Rt*(live REST API) andMk*(in-memory mock), so no mocking framework is needed in tests.Smartclass that wraps the core interface and adds convenience methods, keeping the base interface minimal.JsonReadable/JsonPatchable; there is no ORM or eager mapping, and everyjson()call is a live HTTP round trip.RtPagination<T>followsLink: rel="next"headers lazily;Bulk<T>pre-injects list-response JSON to eliminate N+1 HTTP requests.CarefulWire), retries, and redirects are composed as standalone immutableWiredecorators from jcabi-http, not interceptor chains.Mk*mock persists state in a single XML document mutated with Xembly directives, providing cross-object consistency without HTTP replay.Formatting
All prose lines follow the 80-character soft wrap with two-space continuation indent as specified in the project style.
markdownlintpasses with zero warnings.This PR is ready for merge. @yegor256