Skip to content

Commit

Permalink
Update hypermedia description in both English and Japanese manuals
Browse files Browse the repository at this point in the history
This commit expands upon the previous explanation of hypermedia in BEAR.Sunday's Resource-Oriented Architecture (ROA). It offers a more detailed description of how hyperlinks work within the application, the relationship between resources, and the benefits of reduced coupling between the client and server. The update also includes the concept of using internal links to create containment relationships and improve content structure.
  • Loading branch information
koriym committed Apr 18, 2024
1 parent b00163d commit aa02c43
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
10 changes: 8 additions & 2 deletions manuals/1.0/en/15.tech.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,15 @@ Access to resources is done using HTTP methods (GET, POST, PUT, DELETE). These m
- PUT: Perform idempotent operations on a resource (such as creation or update)
- DELETE: Delete a resource

### Hypermedia
Here's the English translation:

Links between resources are represented by hypermedia. The representation of each resource includes links, and clients can navigate within the application by following these links. This lowers the coupling between client and server and increases the flexibility of the application. Content can also be represented in a tree structure by linking internally.
## Hypermedia

In BEAR.Sunday's Resource-Oriented Architecture (ROA), each resource provides affordances (available operations and functions for the client) through hyperlinks. These links represent the operations available to the client and guide how to navigate within the application. This reduces the coupling between the client and the server, increasing the application's flexibility and extensibility.

Hyperlinks not only represent relationships between resources but also function as a mechanism for embedding resources internally. This is similar to how HTML uses the IMG tag to embed image resources. In BEAR.Sunday, resources can be accessed as independent entities, and internal links can be used to create containment relationships between resources, allowing for declarative composition of the content's tree structure.

BEAR.Sunday's hypermedia approach aligns with the principles of the Web, enhancing the flexibility and extensibility of applications.

### Separation of Value and Representation

Expand Down
10 changes: 7 additions & 3 deletions manuals/1.0/ja/15.tech.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ permalink: /manuals/1.0/ja/tech.html

この章では、BEAR.Sundayの機能と技術的特徴を説明します。

## リソース指向のアーキテクチャ (ROA)
## リソース指向アーキテクチャ (ROA)

> "Resources interconnected, like the web of life that binds all creatures.”
Expand All @@ -27,9 +27,13 @@ URI(Uniform Resource Identifier)は、Webの成功の鍵となる要素で
- PUT: リソースに対して冪等性のある操作を行う(作成または更新など)
- DELETE: リソースを削除する

### ハイパーメディア
## ハイパーメディア

リソース間のリンクはハイパーメディアによって表現されます。各リソースの表現にはリンクが含まれ、クライアントはこれらのリンクをたどることでアプリケーション内を遷移できます。これによってクライアントとサーバー間の結合度が低くなり、アプリケーションの柔軟性が高まります。内部にリンクすることでコンテンツをツリー状に表すこともできます。
BEAR.Sunday のリソース指向アーキテクチャ (ROA) では、各リソースがハイパーリンクを通じてアフォーダンス(クライアントが利用できる操作や機能)を提供します。これらのリンクは、クライアントが利用できる操作を表し、アプリケーション内をナビゲートする方法を指示します。これにより、クライアントとサーバー間の結合度が低くなり、アプリケーションの柔軟性と拡張性が高まります。

ハイパーリンクは、リソース間の関係を表すだけでなく、リソースを内部に埋め込むためのメカニズムとしても機能します。これは、HTMLがIMGタグを使用して画像リソースを埋め込む方法と似ています。 BEAR.Sunday では、リソースを独立したエンティティとしてアクセスできるだけでなく、内部リンクを使用してリソース間に内包関係を作成し、コンテンツのツリー構造を宣言的に構成できます。

BEAR.Sunday のハイパーメディアアプローチは、Webの原則に沿った設計であり、アプリケーションの柔軟性と拡張性を高めます。

### 値と表現の分離

Expand Down

0 comments on commit aa02c43

Please sign in to comment.